Skip to content

Commit b66553c

Browse files
authored
Added quick info to README
1 parent a1d1da4 commit b66553c

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,24 @@
44

55
## Description
66

7-
RubyDep helps users avoid incompatible, buggy and insecure Ruby versions.
7+
RubyDep does 2 things right now:
88

9-
It's for gem owners to add to their runtime dependencies in their gemspec.
9+
1. Helps end users avoid incompatible, buggy and insecure Ruby versions.
10+
2. Helps gem owners manage their gem's `required_ruby_version` gemspec field based on `.travis.yml`.
1011

11-
1. It automatically sets your gemspec's `required_ruby_version` based on rubies tested in your `.travis-yml`
12-
2. It warns users of your project if they're using a buggy or vulnerable version of Ruby
12+
## Quick info
13+
14+
- if you want to know how to disable the warnings, see here: https://github.com/e2/ruby_dep/wiki/Disabling-warnings
15+
- for a list of Ruby versions that can be used to install ruby_dep, see here: https://travis-ci.org/e2/ruby_dep
16+
- if your version of Ruby is not supported, open a new issue and explain your situation/problem
17+
- when in doubt, open a new issue or [read the FAQ on the Wiki](https://github.com/e2/ruby_dep/wiki/FAQ).
18+
- gems using RubyDep are designed to not be installable on a given Ruby version, unless it's specifically declared supported by those gems - but it's ok to ask for supporting your Ruby if you're stuck on an older version (for whatever reason)
19+
- discussions about Ruby versions can get complex and frustrating - please be patient and constructive, and open-minded about solutions - especially if you're having problems
1320

14-
NOTE: RubyDep uses it's own approach on itself. This means it can only be installed on Ruby versions tested here: [check out the Travis build status](https://travis-ci.org/e2/ruby_dep). If you need support for an different/older version of Ruby, open an issue with "backport" in the title and provide a compelling case for supporting the version of Ruby you need.
15-
When in doubt, open a new issue or [read the FAQ on the Wiki](https://github.com/e2/ruby_dep/wiki/FAQ).
1621

22+
## Supported Ruby versions:
23+
24+
NOTE: RubyDep uses it's own approach on itself. This means it can only be installed on Ruby versions tested here: [check out the Travis build status](https://travis-ci.org/e2/ruby_dep). If you need support for an different/older version of Ruby, open an issue with "backport" in the title and provide a compelling case for supporting the version of Ruby you need.
1725

1826
## Problem 1: "Which version of Ruby does your project support?"
1927

0 commit comments

Comments
 (0)