raml-javascript-generator icon indicating copy to clipboard operation
raml-javascript-generator copied to clipboard

Update README

Open kevinduffey opened this issue 7 years ago • 1 comments

Lets put some more content.. a lot more in the README. I dont have a good idea of what this project does, why you would use it, examples of how to use it, etc. The README is the place for this sort of stuff (or at least links to examples, etc). The current README leaves a lot to be desired as to the purpose and use of this project.

kevinduffey avatar Jul 04 '18 18:07 kevinduffey

Title: Generate a JavaScript API client from RAML

I installed it and ran it.

Here is what it did.

It appears to create a api client from your RAML file.

This api client is set up to be published to a repo and npm as a module.

Once thats done, you can npm i <your-module-name> --save into your project and use as a middleware.

I would agree, this could be spelled out for people just for illustration.

For example, I have further questions myself.

alvin-milton avatar Jul 08 '18 23:07 alvin-milton