rdme - ReadMe's API CLI

This is a CLI wrapper around ReadMe's HTTP API.

Installation

npm install rdme

Usage

Uploading a new Swagger file to ReadMe

rdme swagger {path-to-swagger.json} --key={api-key}

Editing an existing Swagger file

rdme swagger {path-to-swagger.json} --key={api-key} --id={existing-id}

Syncing a folder of markdown docs to ReadMe

rdme docs path-to-markdown-files --key={api-key} --version={project-version}

Future

We will be expanding and modifying the feature set of this program as/when we expand our public API. Some things will be changed.