You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-7Lines changed: 30 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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:
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.
6
23
7
24
## Installation
8
25
@@ -22,17 +39,23 @@ Or install it yourself as:
22
39
23
40
## Usage
24
41
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.
26
49
27
50
## Development
28
51
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.
30
53
31
54
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).
32
55
33
56
## Contributing
34
57
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.
0 commit comments