diff --git a/README.md b/README.md index c29a3e5..ba49c4a 100644 --- a/README.md +++ b/README.md @@ -1 +1,55 @@ -# zust \ No newline at end of file +## zust +### ZAP-Rust + +ZAP Oracles (introduction here) + +This repository provides Interface to Zap contracts and tools to use Zap platform with Rust projects +Each package is a public npm module that serve developer's needs to intergrate Zap platform + +# Development + +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes + +### Prerequisites + +``` + +``` + +### Installing + +``` + +``` + +## Running build and tests + +## Packages + +## Usage + +##### Creating a Zap Provider oracle +``` + +``` +**With Custom configuration** +``` + +``` +**Some example for provider usage** + + + +## Built With + + +## Contributing + +Please read [CONTRIBUTING.md]() for details on our code of conduct, and the process for submitting pull requests to us. + + +See also the list of [contributors]() + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details