README.markdown in remedy-0.3.0 vs README.markdown in remedy-0.3.1
- old
+ new
@@ -3,11 +3,11 @@
Remedy is a console interaction framework along the lines of Curses written in pure Ruby. It is modular, making it easy to use what you need and ignore the rest.
[](https://rubygems.org/gems/remedy)
[](https://rubygems.org/gems/remedy)
-[](https://travis-ci.org/acook/remedy)
+[](https://github.com/acook/remedy/actions/workflows/ci.yml)
[](https://codeclimate.com/github/acook/remedy/maintainability)
If you have any suggestions or find any bugs, drop them in GitHub/issues so I can keep track of them. Thanks!
@@ -68,24 +68,22 @@
screen = Viewport.new
screen.draw joke
```
-`Remedy::Partial` has the subclasses `Header`, `Footer`, and `Content`.
+Content in `Remedy::Partial`s will be truncated as needed to accommodate the header and footer and the dimensions of the console. You can also specify the cursor/scroll position of the content being drawn, and when specifying headers or footers, you must.
-You can use the above classes to divide your Views into 3 separate pieces. Content will be truncated as needed to accommodate the header and footer and the dimensions of the console. You can also specify the cursor/scroll position of the content being drawn, and when specifying headers or footers, you must.
-
```ruby
include Remedy
- title = Header.new
+ title = Partial.new
title << "Someone Said These Were Good"
jokes = Content.new
jokes << %q{1. A woman gets on a bus with her baby. The bus driver says: 'Ugh, that's the ugliest baby I've ever seen!' The woman walks to the rear of the bus and sits down, fuming. She says to a man next to her: 'The driver just insulted me!' The man says: 'You go up there and tell him off. Go on, I'll hold your monkey for you.'}
jokes << %q{2. I went to the zoo the other day, there was only one dog in it, it was a shitzu.}
- disclaimer = Footer.new
+ disclaimer = Partial.new
disclaimer << "According to a survey they were funny. I didn't make them."
screen = Viewport.new
screen.draw jokes, Size.new(0,0), title, disclaimer
```
@@ -100,11 +98,11 @@
include Remedy
screen = Viewport.new
Console.set_console_resized_hook! do |size|
- notice = Content.new
+ notice = Partial.new
notice << "You just resized your screen!\n\nNew size:"
notice << size
screen.draw notice
end
```
@@ -112,11 +110,14 @@
Remedy in the Wild
------------------
Remedy was originally written for my own console-based game which was sort of like Dwarf Fortress. Most of the project files were lost, but since Remedy was extracted from it and open-sourced it has lived on.
-Here are a couple of projects that use many of Remedy's features:
+Here are some projects that use Remedy:
+
+- A screenreader-friendly code editor for blind and visually impaired programmers: [Viper](https://github.com/edhowland/viper)
+- [The Official ElasticSearch Ruby Connector](https://github.com/elastic/connectors-ruby)
- A multiplayer Yahtzee for web and console: [YahtzeeGame](https://github.com/ProgrammingPractice/YahtzeeGame)
- Twitter/RSS/Facebook reader: [noizee](https://github.com/acook/noizee)
Check them out!
@@ -131,6 +132,5 @@
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
-