From 6e9031ce31aa36f3a67ec894bedfc7381826ef52 Mon Sep 17 00:00:00 2001 From: Kyle Fuller Date: Mon, 9 Mar 2015 14:09:15 +0000 Subject: [PATCH 1/2] [README] Update for public release --- README.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ea88d8a..e73b3f0 100644 --- a/README.md +++ b/README.md @@ -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://git@github.com: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,5 @@ 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. - -See _Project Settings > Checkout SSH keys > Add User GitHub Key_ in CircleCI settings. - -[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 From a6a3ddd0e58a0febaf033a6c3ae5d9798642476d Mon Sep 17 00:00:00 2001 From: Kyle Fuller Date: Mon, 9 Mar 2015 14:29:53 +0000 Subject: [PATCH 2/2] [README] Mention how to run test suite --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index e73b3f0..b0da34c 100644 --- a/README.md +++ b/README.md @@ -85,5 +85,14 @@ A sample part of payload object is given below } ``` +## Testing + +Inside the drafter repository you can execute the following to run the test suite: + +```bash +$ npm install +$ npm test +``` + [Boutique]: https://github.com/apiaryio/boutique.js [Parse Result]: https://github.com/apiaryio/api-blueprint-ast/blob/master/Parse%20Result.md