feat: improve project readme

README.md

@@ -1,34 +1,22 @@
-# Timer::Cli
+# ⏱️ timer-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/timer/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
+The timer-cli gem is a simple command line interface that allows you to set a timer for a specified amount of time.
 
-TODO: Delete this and the text above, and describe your gem
+![](./screenshot.png)
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
-gem 'timer-cli'
+gem install timer-cli
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install timer-cli
-
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+To start the timer, run the following command:
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+timer --name "My Timer" 25m
+```
 
 ## Contributing
 
@@ -40,4 +28,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Timer::Cli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dvinciguerra/timer-cli/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the `timer-cli` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dvinciguerra/timer-cli/blob/main/CODE_OF_CONDUCT.md).