README.md in peatio-ndc-0.2.1 vs README.md in peatio-ndc-0.2.2
- old
+ new
@@ -1,67 +1,44 @@
-# Peatio::NDC
+# Peatio::Ndc
-Peatio ndc plugin for Rubykube stack
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/peatio/ndc`. To experiment with that code, run `bin/console` for an interactive prompt.
+TODO: Delete this and the text above, and describe your gem
+
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'peatio-ndc'
```
And then execute:
- $ bundle
+ $ bundle install
Or install it yourself as:
$ gem install peatio-ndc
## Usage
-For Peatio NDC plugin integration you need to do the following steps:
+TODO: Write usage instructions here
-### Image Build.
-
-1. Add peatio-ndc gem into your Gemfile.plugin
-```ruby
-gem 'peatio-ndc', '~> 0.1.3'
-```
-
-2. Run `bundle install` for updating Gemfile.lock
-
-3. Build custom Peatio [docker image with NDC plugin](https://github.com/nexbitio/peatio/blob/master/docs/plugins.md#build)
-
-4. Push your image using `docker push`
-
-5. Update your deployment to use image with peatio-ndc gem
-
-### Peatio Configuration.
-
-1. Create NDC Blockchain [config example](../config/blockchains.yml).
- * No additional steps are needed
-
-2. Create NDC Currency [config example](../config/currencies.yml).
- * No additional steps are needed
-
-3. Create NDC Wallets [config example](../config/wallets.yml)(deposit and hot wallets are required).
- * No additional steps are needed
-
-
## Development
-Plugin development [example](https://github.com/nexbitio/peatio/blob/master/docs/coins/development.md).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/nexbitio/peatio-ndc.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/peatio-ndc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/peatio-ndc/blob/master/CODE_OF_CONDUCT.md).
+
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-## Consulting
+## Code of Conduct
-You can contact Openware for finding certified vendors:
-[NEXBIT.IO](https://www.nexbit.io)
+Everyone interacting in the Peatio::Ndc project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/peatio-ndc/blob/master/CODE_OF_CONDUCT.md).