Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.44 KB

README.template.md

File metadata and controls

78 lines (51 loc) · 2.44 KB
Raw

API Client boilerplate template

A boilerplate API client template for those who want to build Rust API client wrappers

Instructions on how to use this template

Note

  • Run the initial-setup.bat and follow the prompts

OR

  • Change the appveyor.yml with your tokens (use secure tokens) or use your preferred CI tool (Circle CI, GitHub Actions, Jenkins, Team City, Azure DevOps)
  • Fix in the readme the path of the badges and remove this section. (change all {username}/{repo} tokens with your own data).
  • Add to readme usage instructions of your client/SDK.
  • Update _config.yml with project details (github.io docs website)

{Project Name} SDK Rust

wakatime Maintainability Test Coverage CodeFactor

Service Status
AppVeyor CI Build status
crates.io crates.io

{{Project Description}}

Dependencies and support

package-name-rs is intended to work on all tier 1 supported Rust systems:

  • MacOSX
  • Linux
  • Windows

Minimum Compiler Version

Due to the use of certain features, package-name-rs requires rustc version 1.18 or higher.

Getting Started

Add the following to your Cargo.toml

[dependencies]
package_name_rs = "0.0.1"
serde_json = "1.0"

Then in your lib.rs or main.rs file add:

extern crate package_name;

let client = PackageNameAPIClient::new();

License

Licensed under

MIT license (LICENSE or http://opensource.org/licenses/MIT)