Skip to content

Commit 5fbc03f

Browse files
Update README.md
1 parent 753a6d4 commit 5fbc03f

File tree

1 file changed

+30
-7
lines changed

1 file changed

+30
-7
lines changed

README.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,25 @@
1-
# TextChart
2-
3-
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.
1+
# TextChart 📊
2+
3+
`TextChart` is a gem that helps you generate text charts, like this one:
4+
```text
5+
text_chart demonstration
6+
Goal: Show you how cool this is
7+
8+
9 |'''''''''''''''''''''''''''''''''''''''''''''''''''''###
9+
8 | ###
10+
7 | ###
11+
6 |'''''''''''''### ###
12+
5 |'''''''''''''###'''''''''''''''''''''''''''### ###
13+
4 |'''''''''''''###'''''''''''''''''''''''''''###'''''''###'''''''###
14+
3 |'''###'''''''###'''''''''''''''''### ### ### ###
15+
2 | ### ### ### ### ### ###
16+
1 | ### ### ### ### ### ###
17+
0 |'''###'''''''###'''''''### ### ### ### ###
18+
----------------------------------------------------------------------
19+
```
20+
## Why?
421

5-
TODO: Delete this and the text above, and describe your gem
22+
This is a pet project. I like ruby and text-based applications, so I combined them.
623

724
## Installation
825

@@ -22,17 +39,23 @@ Or install it yourself as:
2239

2340
## Usage
2441

25-
TODO: Write usage instructions here
42+
This snippet will generate the text chart at the top of the readme.
43+
```ruby
44+
TextChart.new("text_chart demonstration", "Show you how cool this is", [3, 6, 0, 3, 5, 9, 4]).to_s
45+
```
46+
## Limitations
47+
48+
Right now `TextChart` only supports positive integers.
2649

2750
## Development
2851

29-
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.
52+
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.
3053

3154
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).
3255

3356
## Contributing
3457

35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/text_chart.
58+
Bug reports and pull requests are welcome on GitHub at https://github.com/gustavothecoder/text_chart.
3659

3760
## License
3861

0 commit comments

Comments
 (0)