Skip to content

Commit

Permalink
chore(all READMEs): add links to API reference sections
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jgravois committed Mar 30, 2018
1 parent fd9005f commit 3afbe95
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 0 deletions.
3 changes: 3 additions & 0 deletions packages/arcgis-rest-auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
### Example

```bash
npm install @esri/arcgis-rest-request
npm install @esri/arcgis-rest-auth
```

Expand All @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions packages/arcgis-rest-common-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions packages/arcgis-rest-feature-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
### Example

```bash
npm install @esri/arcgis-rest-request
npm install @esri/arcgis-rest-feature-service
```

Expand All @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions packages/arcgis-rest-geocoder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
### Example

```bash
npm install @esri/arcgis-rest-request
npm install @esri/arcgis-rest-geocoder
```

Expand All @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions packages/arcgis-rest-groups/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
### Example

```bash
npm install @esri/arcgis-rest-request
npm install @esri/arcgis-rest-groups
```

Expand All @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions packages/arcgis-rest-items/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
### Example

```bash
npm install @esri/arcgis-rest-request
npm install @esri/arcgis-rest-items
```

Expand All @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions packages/arcgis-rest-request/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 3afbe95

Please sign in to comment.