README.md in tldr-cli-0.1.0 vs README.md in tldr-cli-0.2.0
- old
+ new
@@ -1,35 +1,29 @@
-# Tldr::Cli
+# tldr-cli
-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/tldr/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a simple and tiny tldr-pages client write using Ruby that works well.
-TODO: Delete this and the text above, and describe your gem
## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'tldr-cli'
-```
-
-And then execute:
-
- $ bundle install
-
-Or install it yourself as:
-
$ gem install tldr-cli
## Usage
-TODO: Write usage instructions here
+ $ tldr [command]
+
+Example:
-## Development
+ $ tldr tar
-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.
+## Roadmap
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- [x] basic cli interface
+- [x] tldr-pages markdown content fetch
+- [x] tldr-pages markdown parsing and presentation
+- [ ] implement content caching
+- [ ] content local cache update
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/dvinciguerra/tldr-cli. 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/dvinciguerra/tldr-cli/blob/main/CODE_OF_CONDUCT.md).