This repository has been archived by the owner on Nov 8, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11 from apiaryio/kylef/readme-oss
[README] Update for public release
- Loading branch information
Showing
1 changed file
with
10 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,19 +5,15 @@ | |
Snow Crash parser harness. | ||
|
||
## Introduction | ||
Drafter takes an API blueprint on its input, parses, processes the AST and exposes the [Parse Result][] for further use. | ||
|
||
Want to know more? See the [Drafter Story card][]. | ||
Drafter takes an API blueprint on its input, parses, and then processes the AST to exposes the [Parse Result][] for further use. Drafter expands MSON data structures from the AST and generates JSON representations and JSON Schema representation of MSON structures where they are not found in the original AST. | ||
|
||
## Installation | ||
Node.js v0.10 is required. | ||
|
||
```shell | ||
$ npm install -g git+ssh://[email protected]:apiaryio/drafter.js.git | ||
$ npm install -g drafter | ||
``` | ||
|
||
Because one of Drafter's dependencies, [Boutique][], lives in a private GitHub repository and has no public _npm_ package, it's referenced by its Git URL in `package.json`. Because of this, you may experience some issues while installing or testing. | ||
|
||
## Getting Started | ||
|
||
### Library | ||
|
@@ -89,11 +85,14 @@ A sample part of payload object is given below | |
} | ||
``` | ||
|
||
## Test | ||
In order to run CI tests you need to have access to both Drafter and Boutique repositories and you need to give CircleCI some extended permissions over all your repositories to enable testing on their machines. | ||
## Testing | ||
|
||
See _Project Settings > Checkout SSH keys > Add User GitHub Key_ in CircleCI settings. | ||
Inside the drafter repository you can execute the following to run the test suite: | ||
|
||
```bash | ||
$ npm install | ||
$ npm test | ||
``` | ||
|
||
[Drafter Story card]: https://trello.com/c/lS76AEU3/21-drafter | ||
[Boutique]: https://github.com/apiaryio/boutique | ||
[Boutique]: https://github.com/apiaryio/boutique.js | ||
[Parse Result]: https://github.com/apiaryio/api-blueprint-ast/blob/master/Parse%20Result.md |