README.md in gambiarra-0.0.1 vs README.md in gambiarra-0.0.2
- old
+ new
@@ -1,39 +1,35 @@
# Gambiarra
-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/gambiarra`. To experiment with that code, run `bin/console` for an interactive prompt.
+Gambiarra is an intuitive framework for CLI applications.
-TODO: Delete this and the text above, and describe your gem
+First of all, install it in your machine:
-## Installation
+```shell
+gem install 'gambiarra'
+```
+Then, on the terminal, go inside of your project, or create a new folder, `cd` into it and run:
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'gambiarra'
+```shell
+gambiarra
```
-And then execute:
+Select `install`. You can also use it to create new `views`. That's it!
- $ bundle
-Or install it yourself as:
+You can see it working by running:
- $ gem install gambiarra
+```
+ exe/your_application_name
+```
-## Usage
+Notice it will automatically get the application name by the folder name.
-TODO: Write usage instructions here
+After that, add new views (with questions or not) and happy coding!
-## 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.
-
-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/[USERNAME]/gambiarra. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pedrozath/gambiarra. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).