Skip to content

Commit e5cad4a

Browse files
committed
[chore] Tidy README inaccuracies
1 parent a3264f1 commit e5cad4a

File tree

1 file changed

+18
-23
lines changed

1 file changed

+18
-23
lines changed

README.md

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# JRuby-Rack
22

3-
[![Gem Version](https://badge.fury.io/rb/jruby-rack.png)][8]
4-
[![Build Status](https://github.com/jruby/jruby-rack/actions/workflows/maven.yml/badge.svg)][9]
3+
[![Gem Version](https://badge.fury.io/rb/jruby-rack.png)][5]
4+
[![Build Status](https://github.com/jruby/jruby-rack/actions/workflows/maven.yml/badge.svg)][6]
55

66
JRuby-Rack is a lightweight adapter for the Java Servlet environment that allows
77
any (Ruby) Rack-based application to run unmodified in a Java Servlet container.
@@ -35,9 +35,6 @@ Otherwise you'll need to download the latest [jar release][2], drop it into the
3535
*WEB-INF/lib* directory and configure the `RackFilter` in your application's
3636
*web.xml* (see following examples).
3737

38-
Alternatively you can use a server built upon JRuby-Rack such as [Trinidad][3]
39-
with sensible defaults, without the need to configure a deployment descriptor.
40-
4138
### Rails
4239

4340
Here's sample *web.xml* configuration for Rails. Note the environment and
@@ -183,7 +180,7 @@ JRuby runtime management and pooling is done automatically by the framework.
183180
In the case of Rails, runtimes are pooled by default (the default will most
184181
likely change with the adoption of Rails 4.0). For other Rack applications a
185182
single shared runtime is created and shared for every request by default.
186-
As of **1.1.9** if *jruby.min.runtimes* and *jruby.max.runtimes* values are
183+
If *jruby.min.runtimes* and *jruby.max.runtimes* values are
187184
specified pooling is supported for plain Rack applications as well.
188185

189186
We do recommend to boot your runtimes up-front to avoid the cost of initializing
@@ -304,17 +301,16 @@ For those loggers that require a specific named logger, set it with the
304301
Checkout the JRuby-Rack code using [git](http://git-scm.com/) :
305302

306303
```shell
307-
git clone git://github.com/jruby/jruby-rack.git
304+
git clone git@github.com:jruby/jruby-rack.git
308305
cd jruby-rack
309306
```
310307

311-
Ensure you have [Maven](http://maven.apache.org/) installed.
312-
It is required for downloading jar artifacts that JRuby-Rack depends on.
308+
Ensure you have a compatible JVM installed. It is required for building and compiling.
313309

314310
Build the .jar using Maven :
315311

316312
```shell
317-
mvn install
313+
./mvnw install
318314
```
319315

320316
the generated jar should be located at **target/jruby-rack-*.jar**
@@ -332,21 +328,20 @@ package and push the .jar every time a commit changes a source file).
332328

333329
## Releasing
334330

335-
* Make sure auth is configured for "central" repository ID in your .m2/settings.xml
336-
* Update the version in src/main/ruby/jruby/rack/version.rb to the release version
337-
* mvn release:prepare
338-
* mvn release:perform (possibly with -DuseReleaseProfile=false due to Javadoc doclint failures for now)
339-
* rake clean gem SKIP_SPECS=true and push the gem
331+
* Make sure auth is configured for "central" repository ID in your `.m2/settings.xml`
332+
* Update the version in `src/main/ruby/jruby/rack/version.rb` to the release version
333+
* `./mvnw release:prepare`
334+
* `./mvnw release:perform` (possibly with `-DuseReleaseProfile=false` due to Javadoc doclint failures for now)
335+
* `rake clean gem SKIP_SPECS=true` and push the gem
340336

341337
## Support
342338

343-
Please use [github][4] to file bugs, patches and/or pull requests.
344-
More information at the [wiki][5] or ask us at **#jruby**'s IRC channel.
339+
Please use [github][3] to file bugs, patches and/or pull requests.
340+
More information at the [wiki][4] or ask us at **#jruby**'s IRC channel.
345341

346342
[1]: https://github.com/jruby/warbler#warbler--
347-
[2]: https://oss.sonatype.org/content/repositories/releases/org/jruby/rack/jruby-rack/
348-
[3]: https://github.com/trinidad/trinidad
349-
[4]: https://github.com/jruby/jruby-rack/issues
350-
[5]: https://wiki.github.com/jruby/jruby-rack
351-
[8]: http://badge.fury.io/rb/jruby-rack
352-
[9]: https://github.com/jruby/jruby-rack/actions/workflows/maven.yml
343+
[2]: https://central.sonatype.com/artifact/org.jruby.rack/jruby-rack
344+
[3]: https://github.com/jruby/jruby-rack/issues
345+
[4]: https://github.com/jruby/jruby-rack/wiki
346+
[5]: http://badge.fury.io/rb/jruby-rack
347+
[6]: https://github.com/jruby/jruby-rack/actions/workflows/maven.yml

0 commit comments

Comments
 (0)