From 3afbe95de00abd313f808808236f3a534dea4e84 Mon Sep 17 00:00:00 2001 From: john gravois Date: Fri, 30 Mar 2018 13:46:52 -0700 Subject: [PATCH] chore(all READMEs): add links to API reference sections AFFECTS PACKAGES: @esri/arcgis-rest-auth @esri/arcgis-rest-common-types @esri/arcgis-rest-feature-service @esri/arcgis-rest-geocoder @esri/arcgis-rest-groups @esri/arcgis-rest-items @esri/arcgis-rest-request ISSUES CLOSED: #148 --- packages/arcgis-rest-auth/README.md | 3 +++ packages/arcgis-rest-common-types/README.md | 2 ++ packages/arcgis-rest-feature-service/README.md | 3 +++ packages/arcgis-rest-geocoder/README.md | 3 +++ packages/arcgis-rest-groups/README.md | 3 +++ packages/arcgis-rest-items/README.md | 3 +++ packages/arcgis-rest-request/README.md | 2 ++ 7 files changed, 19 insertions(+) diff --git a/packages/arcgis-rest-auth/README.md b/packages/arcgis-rest-auth/README.md index 3352b1c4bb..1a195d250b 100644 --- a/packages/arcgis-rest-auth/README.md +++ b/packages/arcgis-rest-auth/README.md @@ -14,6 +14,7 @@ ### Example ```bash +npm install @esri/arcgis-rest-request npm install @esri/arcgis-rest-auth ``` @@ -26,6 +27,8 @@ const session = new UserSession({ }); ``` +### [API Reference](https://esri.github.io/arcgis-rest-js/api/auth/) + ### Issues If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you. diff --git a/packages/arcgis-rest-common-types/README.md b/packages/arcgis-rest-common-types/README.md index 89070f60ca..5b293753ca 100644 --- a/packages/arcgis-rest-common-types/README.md +++ b/packages/arcgis-rest-common-types/README.md @@ -24,6 +24,8 @@ const myPoint = { x: -118.409, y: 33.943 } as IPoint ``` +### [API Reference](https://esri.github.io/arcgis-rest-js/api/common-types/) + ### Issues If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you. diff --git a/packages/arcgis-rest-feature-service/README.md b/packages/arcgis-rest-feature-service/README.md index 68d46516a9..fe33add65a 100644 --- a/packages/arcgis-rest-feature-service/README.md +++ b/packages/arcgis-rest-feature-service/README.md @@ -14,6 +14,7 @@ ### Example ```bash +npm install @esri/arcgis-rest-request npm install @esri/arcgis-rest-feature-service ``` @@ -32,6 +33,8 @@ getFeature(params) }); ``` +### [API Reference](https://esri.github.io/arcgis-rest-js/api/feature-service/) + ### Issues If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you. diff --git a/packages/arcgis-rest-geocoder/README.md b/packages/arcgis-rest-geocoder/README.md index 4d214137af..ab0f6a23b7 100644 --- a/packages/arcgis-rest-geocoder/README.md +++ b/packages/arcgis-rest-geocoder/README.md @@ -14,6 +14,7 @@ ### Example ```bash +npm install @esri/arcgis-rest-request npm install @esri/arcgis-rest-geocoder ``` @@ -26,6 +27,8 @@ geocode("LAX") }); ``` +### [API Reference](https://esri.github.io/arcgis-rest-js/api/geocoder/) + ### Issues If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you. diff --git a/packages/arcgis-rest-groups/README.md b/packages/arcgis-rest-groups/README.md index b33669ac9a..6d527504a0 100644 --- a/packages/arcgis-rest-groups/README.md +++ b/packages/arcgis-rest-groups/README.md @@ -14,6 +14,7 @@ ### Example ```bash +npm install @esri/arcgis-rest-request npm install @esri/arcgis-rest-groups ``` @@ -26,6 +27,8 @@ searchGroups({q:"water"}) }); ``` +### [API Reference](https://esri.github.io/arcgis-rest-js/api/groups/) + ### Issues If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you. diff --git a/packages/arcgis-rest-items/README.md b/packages/arcgis-rest-items/README.md index f70a0ccee1..88cbeae733 100644 --- a/packages/arcgis-rest-items/README.md +++ b/packages/arcgis-rest-items/README.md @@ -14,6 +14,7 @@ ### Example ```bash +npm install @esri/arcgis-rest-request npm install @esri/arcgis-rest-items ``` @@ -28,6 +29,8 @@ getItem(itemId) }); ``` +### [API Reference](https://esri.github.io/arcgis-rest-js/api/items/) + ### Issues If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you. diff --git a/packages/arcgis-rest-request/README.md b/packages/arcgis-rest-request/README.md index 22cec88ccd..ebc3f9b0c7 100644 --- a/packages/arcgis-rest-request/README.md +++ b/packages/arcgis-rest-request/README.md @@ -28,6 +28,8 @@ request(url) }); ``` +### [API Reference](https://esri.github.io/arcgis-rest-js/api/request/) + ### Issues If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first. Have you found a new bug? Want to request a new feature? We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you.