API Canary - Command Line Tool

A command line app to publish to API Canary

View Demo · Report Bug · Request Feature · Send a Pull Request

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact

Getting Started

How to add the API Canary commandline app to your nodejs application

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Enter your app's repo

cd my_nodejs_app

2. Install NPM package

npm install apicanary

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are extremely appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Describe your License for your project.

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @apicanary - [email protected]

Project Link: https://github.com/apicanary/apicanary