You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by oc...@apache.org on 2022/10/13 18:46:19 UTC
[trafficcontrol-trafficops-types] 13/38: Add a bunch of info to package.json
This is an automated email from the ASF dual-hosted git repository.
ocket8888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol-trafficops-types.git
commit 8bdc6e9e19b99437f4b9b72bdbbc5f723ce562d0
Author: ocket8888 <oc...@apache.org>
AuthorDate: Wed Apr 27 22:38:08 2022 -0600
Add a bunch of info to package.json
---
README.md | 4 ++++
package.json | 31 ++++++++++++++++++++++++++-----
2 files changed, 30 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 10f6205..8a0a8f1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,6 @@
# trafficops-types
Typescript types and utility functions for Traffic Ops API objects.
+
+There's not much to document, it's mostly just types, but to see the
+documentation, install the development dependencies and use the `doc` NPM script
+like: `npm run doc`.
diff --git a/package.json b/package.json
index e9f1837..bf7c2de 100644
--- a/package.json
+++ b/package.json
@@ -1,18 +1,39 @@
{
"name": "trafficops-types",
- "version": "3.1.0-beta-2",
+ "version": "3.1.0-beta-3",
"description": "A library for dealing with Apache Traffic Control objects",
"main": "dist/index.js",
"scripts": {
- "test": "echo \"Error: no test specified\" && exit 1",
"build": "tsc",
"lint": "eslint --ext .ts .",
"clean": "rm -rf dist",
"doc": "typedoc --includeVersion --readme ./README.md src/index.ts"
},
- "keywords": [],
- "author": "",
- "license": "ISC",
+ "keywords": [
+ "Traffic Ops",
+ "trafficops",
+ "Traffic Control",
+ "Apache Traffic Control",
+ "ATC"
+ ],
+ "author": {
+ "email": "ocket8888@apache.org",
+ "name": "ocket8888",
+ "url": "https://github.com/ocket8888"
+ },
+ "files": [
+ "dist/*"
+ ],
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/ocket8888/trafficops-types.git"
+ },
+ "license": "GPL-3.0-or-later",
+ "homepage": "https://github.com/ocket8888/trafficops-types#readme",
+ "bugs": {
+ "email": "ocket8888@apache.org",
+ "url": "https://github.com/ocket8888/trafficops-types/issues"
+ },
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^5.0.0",
"@typescript-eslint/parser": "^5.0.0",