From 5fbc03f87581017964c9672ce72b4985dfb00288 Mon Sep 17 00:00:00 2001
From: Gustavo Ribeiro <57065994+gustavothecoder@users.noreply.github.com>
Date: Sun, 24 Dec 2023 14:37:02 -0300
Subject: [PATCH] Update README.md

---
 README.md | 37 ++++++++++++++++++++++++++++++-------
 1 file changed, 30 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 8bd3142..35d6d35 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,25 @@
-# TextChart
-
-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/text_chart`. To experiment with that code, run `bin/console` for an interactive prompt.
+# TextChart 📊
+
+`TextChart` is a gem that helps you generate text charts, like this one:
+```text
+ text_chart demonstration
+ Goal: Show you how cool this is
+
+ 9 |'''''''''''''''''''''''''''''''''''''''''''''''''''''###
+ 8 |                                                     ###
+ 7 |                                                     ###
+ 6 |'''''''''''''###                                     ###
+ 5 |'''''''''''''###'''''''''''''''''''''''''''###       ###
+ 4 |'''''''''''''###'''''''''''''''''''''''''''###'''''''###'''''''###
+ 3 |'''###'''''''###'''''''''''''''''###       ###       ###       ###
+ 2 |   ###       ###                 ###       ###       ###       ###
+ 1 |   ###       ###                 ###       ###       ###       ###
+ 0 |'''###'''''''###'''''''###       ###       ###       ###       ###
+   ----------------------------------------------------------------------
+```
+## Why?
 
-TODO: Delete this and the text above, and describe your gem
+This is a pet project. I like ruby and text-based applications, so I combined them.
 
 ## Installation
 
@@ -22,17 +39,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This snippet will generate the text chart at the top of the readme.
+```ruby
+TextChart.new("text_chart demonstration", "Show you how cool this is", [3, 6, 0, 3, 5, 9, 4]).to_s
+```
+## Limitations
+
+Right now `TextChart` only supports positive integers.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/text_chart.
+Bug reports and pull requests are welcome on GitHub at https://github.com/gustavothecoder/text_chart.
 
 ## License