From 017f97468073ba8693cb4036aa6e2fca6e3f62ff Mon Sep 17 00:00:00 2001 From: Frank Purcell Date: Thu, 23 Jan 2020 21:49:51 -0800 Subject: [PATCH] fix(cleanup): added def README and also cleaned up the packages --- packages/endpoints-overlay/README.md | 5 +++++ packages/endpoints-overlay/package.json | 6 +++--- packages/from-to-location-picker/package.json | 4 ++-- packages/park-and-ride-overlay/README.md | 5 +++++ packages/park-and-ride-overlay/package.json | 8 ++++---- packages/route-viewer-overlay/README.md | 5 +++++ packages/route-viewer-overlay/package.json | 6 +++--- packages/stop-viewer-overlay/README.md | 5 +++++ packages/stop-viewer-overlay/package.json | 6 +++--- packages/stops-overlay/package.json | 6 +++--- packages/transitive-overlay/README.md | 5 +++++ packages/transitive-overlay/package.json | 16 ++++++++-------- packages/trip-form/README.md | 5 +++++ packages/trip-viewer-overlay/README.md | 5 +++++ packages/trip-viewer-overlay/package.json | 6 +++--- packages/vehicle-rental-overlay/README.md | 5 +++++ packages/vehicle-rental-overlay/package.json | 14 +++++++------- 17 files changed, 76 insertions(+), 36 deletions(-) create mode 100644 packages/endpoints-overlay/README.md create mode 100644 packages/park-and-ride-overlay/README.md create mode 100644 packages/route-viewer-overlay/README.md create mode 100644 packages/stop-viewer-overlay/README.md create mode 100644 packages/transitive-overlay/README.md create mode 100644 packages/trip-form/README.md create mode 100644 packages/trip-viewer-overlay/README.md create mode 100644 packages/vehicle-rental-overlay/README.md diff --git a/packages/endpoints-overlay/README.md b/packages/endpoints-overlay/README.md new file mode 100644 index 000000000..1ef175f30 --- /dev/null +++ b/packages/endpoints-overlay/README.md @@ -0,0 +1,5 @@ +## Usage + +``` +TBD +``` diff --git a/packages/endpoints-overlay/package.json b/packages/endpoints-overlay/package.json index 9e43c648e..bc9c14497 100644 --- a/packages/endpoints-overlay/package.json +++ b/packages/endpoints-overlay/package.json @@ -3,6 +3,9 @@ "version": "0.0.11", "description": "A map overlay to show the from and to locations of an itinerary", "main": "lib/index.js", + "author": "Evan Siroky", + "license": "MIT", + "homepage": "https://github.com/opentripplanner/otp-ui#readme", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, @@ -10,12 +13,9 @@ "type": "git", "url": "git+https://github.com/opentripplanner/otp-ui.git" }, - "author": "Evan Siroky", - "license": "MIT", "bugs": { "url": "https://github.com/opentripplanner/otp-ui/issues" }, - "homepage": "https://github.com/opentripplanner/otp-ui#readme", "dependencies": { "@opentripplanner/core-utils": "^0.0.11", "@opentripplanner/location-icon": "^0.0.11", diff --git a/packages/from-to-location-picker/package.json b/packages/from-to-location-picker/package.json index a793bf541..88dcf9553 100644 --- a/packages/from-to-location-picker/package.json +++ b/packages/from-to-location-picker/package.json @@ -9,8 +9,8 @@ "module": "src/index.js", "private": false, "dependencies": { - "@opentripplanner/core-utils": "^0.0.11", - "@opentripplanner/location-icon": "^0.0.11", + "@opentripplanner/core-utils": "^0.0.11", + "@opentripplanner/location-icon": "^0.0.11", "prop-types": "^15.7.2" }, "peerDependencies": { diff --git a/packages/park-and-ride-overlay/README.md b/packages/park-and-ride-overlay/README.md new file mode 100644 index 000000000..1ef175f30 --- /dev/null +++ b/packages/park-and-ride-overlay/README.md @@ -0,0 +1,5 @@ +## Usage + +``` +TBD +``` diff --git a/packages/park-and-ride-overlay/package.json b/packages/park-and-ride-overlay/package.json index df34dc082..3fe899676 100644 --- a/packages/park-and-ride-overlay/package.json +++ b/packages/park-and-ride-overlay/package.json @@ -3,6 +3,9 @@ "version": "0.0.1", "description": "A map overlay to show park and rides", "main": "lib/index.js", + "homepage": "https://github.com/opentripplanner/otp-ui#readme", + "author": "Evan Siroky", + "license": "MIT", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, @@ -10,20 +13,17 @@ "type": "git", "url": "git+https://github.com/opentripplanner/otp-ui.git" }, - "author": "Evan Siroky", - "license": "MIT", "bugs": { "url": "https://github.com/opentripplanner/otp-ui/issues" }, - "homepage": "https://github.com/opentripplanner/otp-ui#readme", "dependencies": { "@opentripplanner/core-utils": "^0.0.11", "@opentripplanner/from-to-location-picker": "^0.0.11", + "@opentripplanner/base-map": "^0.0.11", "prop-types": "^15.7.2", "react-leaflet": "^2.6.1" }, "peerDependencies": { - "@opentripplanner/base-map": "^0.0.11", "react": "^16.8.6", "react-dom": "^16.8.6", "styled-components": "^4.3.1" diff --git a/packages/route-viewer-overlay/README.md b/packages/route-viewer-overlay/README.md new file mode 100644 index 000000000..1ef175f30 --- /dev/null +++ b/packages/route-viewer-overlay/README.md @@ -0,0 +1,5 @@ +## Usage + +``` +TBD +``` diff --git a/packages/route-viewer-overlay/package.json b/packages/route-viewer-overlay/package.json index d89b6582e..e850ebedb 100644 --- a/packages/route-viewer-overlay/package.json +++ b/packages/route-viewer-overlay/package.json @@ -3,6 +3,9 @@ "version": "0.0.11", "description": "A map overlay to show a transit route", "main": "lib/index.js", + "author": "Evan Siroky", + "license": "MIT", + "homepage": "https://github.com/opentripplanner/otp-ui#readme", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, @@ -10,12 +13,9 @@ "type": "git", "url": "git+https://github.com/opentripplanner/otp-ui.git" }, - "author": "Evan Siroky", - "license": "MIT", "bugs": { "url": "https://github.com/opentripplanner/otp-ui/issues" }, - "homepage": "https://github.com/opentripplanner/otp-ui#readme", "dependencies": { "@mapbox/polyline": "^1.1.0", "@opentripplanner/core-utils": "^0.0.11", diff --git a/packages/stop-viewer-overlay/README.md b/packages/stop-viewer-overlay/README.md new file mode 100644 index 000000000..1ef175f30 --- /dev/null +++ b/packages/stop-viewer-overlay/README.md @@ -0,0 +1,5 @@ +## Usage + +``` +TBD +``` diff --git a/packages/stop-viewer-overlay/package.json b/packages/stop-viewer-overlay/package.json index 54fa3ad1c..7c2abae86 100644 --- a/packages/stop-viewer-overlay/package.json +++ b/packages/stop-viewer-overlay/package.json @@ -3,6 +3,9 @@ "version": "0.0.11", "description": "A map overlay to show a stop", "main": "lib/index.js", + "author": "Evan Siroky", + "license": "MIT", + "homepage": "https://github.com/opentripplanner/otp-ui#readme", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, @@ -10,12 +13,9 @@ "type": "git", "url": "git+https://github.com/opentripplanner/otp-ui.git" }, - "author": "Evan Siroky", - "license": "MIT", "bugs": { "url": "https://github.com/opentripplanner/otp-ui/issues" }, - "homepage": "https://github.com/opentripplanner/otp-ui#readme", "dependencies": { "@opentripplanner/core-utils": "^0.0.11", "@opentripplanner/base-map": "^0.0.11", diff --git a/packages/stops-overlay/package.json b/packages/stops-overlay/package.json index f64d667df..fcce2a75a 100644 --- a/packages/stops-overlay/package.json +++ b/packages/stops-overlay/package.json @@ -3,6 +3,9 @@ "version": "0.0.11", "description": "A map overlay to show transit stops", "main": "lib/index.js", + "author": "Evan Siroky", + "license": "MIT", + "homepage": "https://github.com/opentripplanner/otp-ui#readme", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, @@ -10,12 +13,9 @@ "type": "git", "url": "git+https://github.com/opentripplanner/otp-ui.git" }, - "author": "Evan Siroky", - "license": "MIT", "bugs": { "url": "https://github.com/opentripplanner/otp-ui/issues" }, - "homepage": "https://github.com/opentripplanner/otp-ui#readme", "dependencies": { "@opentripplanner/core-utils": "^0.0.11", "@opentripplanner/from-to-location-picker": "^0.0.11", diff --git a/packages/transitive-overlay/README.md b/packages/transitive-overlay/README.md new file mode 100644 index 000000000..1ef175f30 --- /dev/null +++ b/packages/transitive-overlay/README.md @@ -0,0 +1,5 @@ +## Usage + +``` +TBD +``` diff --git a/packages/transitive-overlay/package.json b/packages/transitive-overlay/package.json index d21f7c07f..14f71a326 100644 --- a/packages/transitive-overlay/package.json +++ b/packages/transitive-overlay/package.json @@ -3,6 +3,12 @@ "version": "0.0.11", "description": "A map overlay to show an itinerary", "main": "lib/index.js", + "author": "Evan Siroky", + "license": "MIT", + "homepage": "https://github.com/opentripplanner/otp-ui#readme", + "bugs": { + "url": "https://github.com/opentripplanner/otp-ui/issues" + }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, @@ -10,16 +16,12 @@ "type": "git", "url": "git+https://github.com/opentripplanner/otp-ui.git" }, - "author": "Evan Siroky", - "license": "MIT", - "bugs": { - "url": "https://github.com/opentripplanner/otp-ui/issues" - }, - "homepage": "https://github.com/opentripplanner/otp-ui#readme", "dependencies": { "@opentripplanner/base-map": "^0.0.11", "@opentripplanner/core-utils": "^0.0.11", + "@opentripplanner/endpoints-overlay": "^0.0.11", "@opentripplanner/icons": "^0.0.11", + "@opentripplanner/itinerary-body": "^0.0.11", "lodash.isequal": "^4.5.0", "react-leaflet": "^2.6.1", "transitive-js": "^0.13.0" @@ -28,8 +30,6 @@ "react": "^16.8.6" }, "devDependencies": { - "@opentripplanner/endpoints-overlay": "^0.0.11", - "@opentripplanner/itinerary-body": "^0.0.11", "lodash.clonedeep": "^4.5.0" } } diff --git a/packages/trip-form/README.md b/packages/trip-form/README.md new file mode 100644 index 000000000..1ef175f30 --- /dev/null +++ b/packages/trip-form/README.md @@ -0,0 +1,5 @@ +## Usage + +``` +TBD +``` diff --git a/packages/trip-viewer-overlay/README.md b/packages/trip-viewer-overlay/README.md new file mode 100644 index 000000000..1ef175f30 --- /dev/null +++ b/packages/trip-viewer-overlay/README.md @@ -0,0 +1,5 @@ +## Usage + +``` +TBD +``` diff --git a/packages/trip-viewer-overlay/package.json b/packages/trip-viewer-overlay/package.json index b5a534aa7..289602eea 100644 --- a/packages/trip-viewer-overlay/package.json +++ b/packages/trip-viewer-overlay/package.json @@ -3,6 +3,9 @@ "version": "0.0.11", "description": "A map overlay to show a trip of a route", "main": "lib/index.js", + "author": "Evan Siroky", + "license": "MIT", + "homepage": "https://github.com/opentripplanner/otp-ui#readme", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, @@ -10,12 +13,9 @@ "type": "git", "url": "git+https://github.com/opentripplanner/otp-ui.git" }, - "author": "Evan Siroky", - "license": "MIT", "bugs": { "url": "https://github.com/opentripplanner/otp-ui/issues" }, - "homepage": "https://github.com/opentripplanner/otp-ui#readme", "dependencies": { "@mapbox/polyline": "^1.1.0", "@opentripplanner/base-map": "^0.0.11", diff --git a/packages/vehicle-rental-overlay/README.md b/packages/vehicle-rental-overlay/README.md new file mode 100644 index 000000000..1ef175f30 --- /dev/null +++ b/packages/vehicle-rental-overlay/README.md @@ -0,0 +1,5 @@ +## Usage + +``` +TBD +``` diff --git a/packages/vehicle-rental-overlay/package.json b/packages/vehicle-rental-overlay/package.json index 852672201..592c2a8bf 100644 --- a/packages/vehicle-rental-overlay/package.json +++ b/packages/vehicle-rental-overlay/package.json @@ -3,6 +3,12 @@ "version": "0.0.1", "description": "A map overlay to show vehicle rentals from a specific company", "main": "lib/index.js", + "author": "Evan Siroky", + "license": "MIT", + "homepage": "https://github.com/opentripplanner/otp-ui#readme", + "bugs": { + "url": "https://github.com/opentripplanner/otp-ui/issues" + }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, @@ -10,22 +16,16 @@ "type": "git", "url": "git+https://github.com/opentripplanner/otp-ui.git" }, - "author": "Evan Siroky", - "license": "MIT", - "bugs": { - "url": "https://github.com/opentripplanner/otp-ui/issues" - }, - "homepage": "https://github.com/opentripplanner/otp-ui#readme", "dependencies": { "@opentripplanner/core-utils": "^0.0.11", "@opentripplanner/from-to-location-picker": "^0.0.11", + "@opentripplanner/base-map": "^0.0.11", "lodash.memoize": "^4.1.2", "prop-types": "^15.7.2", "react-leaflet": "^2.6.1", "styled-icons": "^9.1.0" }, "peerDependencies": { - "@opentripplanner/base-map": "^0.0.11", "react": "^16.8.6", "react-dom": "^16.8.6", "styled-components": "^4.3.1"