Skip to content

Commit 48f12a4

Browse files
Update readme instructions
1 parent 9bc0522 commit 48f12a4

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ If you are looking for the app behind https://emberjs.com/api/, visit
44
[ember-api-docs](https://github.com/ember-learn/ember-api-docs) instead. This ember-jsonapi-docs
55
repository is internal tooling that is not required to run the ember-api-docs app locally.
66

7-
ember-jsonapi-docs is for turning code comments in [ember.js](https://github.com/emberjs/ember.js) into
7+
`ember-jsonapi-docs` is for turning code comments in [ember.js](https://github.com/emberjs/ember.js) into
88
[json api](http://jsonapi.org/) compliant data for use in various applications seeking to use the Ember API.
99

1010
The script pulls yuidoc build output from all Ember versions from Amazon S3, converts it to json api format and creates an archive. It can also be run to build jsonapi docs from a local copy of ember.js.
1111

1212
## Running the app
1313

1414
1. Fork/Clone [ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs)
15-
1. Run `yarn` or `npm install` (Needs node 6+)
15+
1. Run `yarn` or `npm install` (Needs node 8)
1616
1. Set up AWS access
1717

1818
```shell
@@ -59,4 +59,5 @@ app with documentation pulled from a local copy of ember.js.
5959
1. From the `ember-jsonapi-docs` directory, run `./generate-local.sh yui ember 2.18.0`. This command runs the Ember documentation build, generates jsonapi output, and copies it to the `ember-api-docs` directory. To build ember data documentation, run `./generate-local.sh yui ember-data 2.17.2`.
6060
- If your `rev-index/ember-X.X.X.json` file fails to generate, make sure you have all dependencies installed for the ember.js repo
6161
- If you are debugging failed builds, periodically clear out the contents of the `tmp` directory, and run the script again. Past failed runs can cause subsequent runs to fail in unexpected ways.\_
62-
1. Run the API app with the newly generated local data by running `API_HOST=http://localhost:4200 ember s` in the `ember-api-docs` directory.
62+
1. Run `yarn server` in this app to serve the content locally.
63+
1. Run the API app with the newly generated local data by running `API_HOST=http://localhost:5050 ember s` in the `ember-api-docs` directory.

0 commit comments

Comments
 (0)