README.md in scale_rb-0.4.2 vs README.md in scale_rb-0.5.0
- old
+ new
@@ -1,15 +1,13 @@
# ScaleRb
-It is still under heavy development. Use the latest version.
-
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'scale_rb', '~> 0.4.2'
+gem "scale_rb"
```
And then execute:
$ bundle install
@@ -23,22 +21,36 @@
```bash
git clone https://github.com/wuminzhe/scale_rb.git
cd scale_rb
bundle install
bundle exec ruby examples/http_client_1.rb
-# CONSOLE_LEVEL=debug bundle exec ruby examples/http_client_1.rb
```
## Development
-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.
+### Run devcontainer
-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).
+Open the project in vscode, then in the command palette, type `Reopen in Container` to open the project in a devcontainer.
+
+
+
+After the devcontainer is opened, you can run the following commands:
+
+1. Tests:
+
+ ```bash
+ bundle exec rspec
+ ```
+
+2. Examples:
+ ```bash
+ bundle exec ruby examples/http_client_1.rb
+ ```
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/wuminzhe/scale_rb. 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/wuminzhe/scale_rb/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).