Skip to content

Update README.md #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
revolter wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ sudo npm install commandcar -g

# Using commandcar

A fresh commandcar install is a powerful yet empty skeleton. In order to make commandcar usable you need to `install` API definitions, and that's how you extend its power.
A fresh commandcar install is a powerful yet empty skeleton. In order to make commandcar usable, you need to `install` API definitions, and that's how you extend its power.

API Definitions are [swagger2.0](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md) files. You can create them yourself -- for example if you're developing an API and want to use commandcar to run automated tests against it -- or you can use existing public files. commandcar accepts either `json` or `yaml` swagger files.

Expand Down Expand Up @@ -49,7 +49,7 @@ commandcar install --name my_api --url http://some.domain.com/my/api/swagger.yam
commandcar install --name instagram --api_model instagram.com/1.0.0
```

You can browse through the available APIs [here](https://github.com/APIs-guru/api-models/tree/master/APIs) and use the relative path to the directory containing the swagger file from this path onward. For example, the instagram API v1 resides here: https://github.com/APIs-guru/api-models/tree/master/APIs/instagram.com/1.0.0. Use "instagram.com/1.0.0" as the value for the --api_model argument. No trailing slashes please.
You can browse through the available APIs [here](https://github.com/APIs-guru/api-models/tree/master/APIs) and use the relative path to the directory containing the swagger file from this path onward. For example, the instagram API v1 resides here: https://github.com/APIs-guru/api-models/tree/master/APIs/instagram.com/1.0.0. Use "instagram.com/1.0.0" as the value for the --api_model argument. No trailing slashes, please.

## Upgrading/modifying an installed API

Expand Down Expand Up @@ -142,7 +142,7 @@ Note: Facebook is used as an example API throughout this doc, though we didn't p

This is an option that is attached automatically to any command and enables you to specify exactly what you wish to receive as output.

So for example let's assume you make this call:
So, for example, let's assume you make this call:

```
commandcar facebook.get_user --accees_token 123456 --ret first_name
Expand All @@ -163,8 +163,8 @@ Then the output would be simply `John` instead of the entire json.

* --ret can only work on json responses
* command line functionality itself, i.e. required arguments are not enforced etc.
* program can be heavy with lots of APIs installed. Needs to imporve caching for consecutive invokations
* program can be heavy with lots of APIs installed. Needs to improve caching for consecutive invocations

# Gitter

We're on [gitter](https://gitter.im/tikalk/commandcar) if you want to talk with us.
We're on [gitter](https://gitter.im/tikalk/commandcar) if you want to talk with us.