docs: Docs fixes (#285)

* docs: put alpha tag * docs: point out they need to use the provided script
stoplightio · May 10, 2019 · 2a0d8f8 · 2a0d8f8
1 parent 02e2511
commit 2a0d8f8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -34,7 +34,7 @@ Yarn is a package manager for your code, similar to npm. While you can use npm t
 2. Fork the [https://github.com/stoplightio/prism](https://github.com/stoplightio/prism) repo.
 3. Git clone your fork (i.e. `git clone https://github.com/<your-username>/prism.git`) to your machine.
 4. Run `yarn` to install dependencies and setup the project.
-5. Reference the bin directly, for example `./packages/cli/bin/run mock openapi.yaml`
+5. Because [oclif](https://oclif.io) does not respect the provided `tsconfig`, you can't use the bin directly, but we provide a script for that: `cd packages && yarn cli mock openapi.yaml`
 6. Run `git checkout -b [name_of_your_new_branch]` to create a new branch for your work. To help build nicer changelogs, we have a convention for branch names. Please start your branch with either `feature/{branch-name}`, `chore/{branch-name}`, or `fix/{branch-name}`. For example, if I was adding a CLI, I would make my branch name: `feature/add-cli`.
 7. Make changes, write code and tests, etc. The fun stuff!
 8. Run `yarn test` to test your changes.

diff --git a/README.md b/README.md
@@ -24,9 +24,9 @@ Look at the relative repositories' READMEs for the specific documentation.
 Most of the users will probably want to use the CLI, which is a Node module, and can either be installed via NPM or Yarn…
 
 ```bash
-npm install -g @stoplight/prism-cli
+npm install -g @stoplight/prism-cli@alpha
 # or
-yarn global add @stoplight/prism-cli
+yarn global add @stoplight/prism-cli@alpha
 ```
 
 …or if you do not want to install [Node](https://nodejs.org), you can download the latest release from [GitHub directly][download-release]