README.md in nubank_sdk-0.6.1 vs README.md in nubank_sdk-0.7.0
- old
+ new
@@ -1,73 +1,123 @@
-
+# NubankSdk
-# NubankSdk (Work in progress)
+[](https://rubygems.org/gems/nubank_sdk)
+[](https://rubygems.org/gems/nubank_sdk)
+[](https://github.com/Viserion77/nubank_sdk/actions/workflows/quality-inspector.yml?branch=develop)
A gem to make it ease to monitorize your Nubank account.
-<!-- 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/nubank_sdk`. To experiment with that code, run `bin/console` for an interactive prompt. -->
-
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'nubank_sdk'
```
And then execute:
- $ bundle
+```shell
+bundle
+```
Or install it yourself as:
- $ gem install nubank_sdk
+```shell
+gem install nubank_sdk
+```
## Usage
```ruby
require 'nubank_sdk'
# instance a nubank account object
-user = NubankSdk::User.new(cpf: '12345678909')
+user = NubankSdk::User.new cpf: '12345678909'
password = 'dracarys'
```
-> First time?
+> First time? authenticate the account!
>
-> authenticate the account
->
> ```ruby
> # request an email code
> account_email = user.auth.request_email_code(password)
>
> # get the email code from the user
> puts "Enter the code sent to #{account_email}: "
> email_code = gets.chomp
> user.auth.exchange_certs(email_code, password)
> ```
>
----
->
-> Has a certificate?
->
-> generate a access token
->
-> ```ruby
-> user.auth.authenticate_with_certificate(password)
-> ```
+Has a certificate? generate a access token :D
+```ruby
+user.auth.authenticate_with_certificate(password)
+```
+
get the account balance
```ruby
-user.account.balance # => 77.0
+account_balance = user.account.balance # => 77.0
```
## 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.
+> <details>
+>
+> <summary>Prerequisites</summary>
+>
+> - Ruby 2.7.2
+> - Bundler
+> - git
+>
+> Clone the repository:
+> ```shell
+> git clone https://github.com/viserion77/nubank_sdk.git
+> ```
+>
+> Install the dependencies:
+> ```shell
+> bundle install
+> ```
+>
+> </details>
-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).
+- Create a new branch for your feature or bugfix
+- Commit your changes, and push your branch to GitHub
+- Open a Pull Request to the `develop` branch
+- Write a description for your PR, and how to test it!
+- Wait for the CI to run the tests and check the code quality
+- If everything is ok, your PR will be merged
+
+## Deployment
+
+> <details>
+>
+> <summary>Prerequisites</summary>
+>
+> - Ruby 2.7.2
+> - Bundler
+> - git
+>
+> Clone the repository:
+> ```shell
+> git clone https://github.com/viserion77/nubank_sdk.git
+> ```
+>
+> Install the dependencies:
+> ```shell
+> bundle install
+> ```
+>
+> </details>
+
+- Create a new branch from `develop` for bumping the version
+- run `bundle exec rake start_new_release` to bump the version and a new tag
+- Open a Pull Request to the `main` branch
+- If everything is ok, your PR will be merged
+- After the merge, the CI will publish the new version to rubygems.org
+- If all goes well, you need release the new tag to GitHub. ([tags](https://github.com/Viserion77/nubank_sdk/tags))
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/viserion77/nubank_sdk.