Skip to content

Commit eda1b7e

Browse files
committed
Update the README to prepare for publishing
1 parent 80780d3 commit eda1b7e

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ Overlays are a way to extend or enhance an existing [OpenAPI description](https:
1414

1515
## Installation
1616

17-
This project isn't published as a package yet, so:
17+
Install the `overlayjs` command from [npm](https://npmjs.com) with the following command:
1818

19-
* Clone this repo
20-
* Run `npm install` to get the dependencies
21-
* Run `npm install -g` to get `overlayjs` as a command
19+
```text
20+
npm install -g openapi-overlay-js
21+
```
2222

23-
> **Pro-tip:** you can also use `node index.js` from the root of the project if you don't want to install a global command.
23+
The `-g` switch installs it globally so you can use the command from anywhere on your system.
24+
25+
> **Pro-tip:** use `node index.js` from the root of the project if you're using the bleeding edge of the project or working on a branch.
2426
2527
## Usage
2628

@@ -32,6 +34,6 @@ See [docs/examples](docs/examples/index.md) for more examples.
3234

3335
## Project status
3436

35-
This project is very much at idea stage but feedback, comments and questions are all very welcome as issues on this repository - and pull requests are also gratefully received. It would be excellent to hear what problem this tool can solve, and how you get on with it. Bonus points if you can share examples (working or broken) of what you tried.
37+
:warning: Project status: alpha
3638

37-
:warning: please be aware that absolutely anything may change at any time, it would probably be safest to pin to a specific commit for now.
39+
This project is very much at an alpha stage but feedback, comments and questions are all very welcome as issues on this repository - and pull requests are also gratefully received. It would be excellent to hear what problem this tool can solve, and how you get on with it. Bonus points if you can share examples (working or broken) of what you tried.

0 commit comments

Comments
 (0)