Skip to content

Commit a96238f

Browse files
committed
[chore] Tidy README inaccuracies
(cherry picked from commit e5cad4a)
1 parent ce85f7b commit a96238f

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.
@@ -33,9 +33,6 @@ Otherwise you'll need to download the latest [jar release][2], drop it into the
3333
*WEB-INF/lib* directory and configure the `RackFilter` in your application's
3434
*web.xml* (see following examples).
3535

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

4138
Here's sample *web.xml* configuration for Rails. Note the environment and
@@ -176,7 +173,7 @@ JRuby runtime management and pooling is done automatically by the framework.
176173
In the case of Rails, runtimes are pooled by default (the default will most
177174
likely change with the adoption of Rails 4.0). For other Rack applications a
178175
single shared runtime is created and shared for every request by default.
179-
As of **1.1.9** if *jruby.min.runtimes* and *jruby.max.runtimes* values are
176+
If *jruby.min.runtimes* and *jruby.max.runtimes* values are
180177
specified pooling is supported for plain Rack applications as well.
181178

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

316313
```shell
317-
git clone git://github.com/jruby/jruby-rack.git
314+
git clone git@github.com:jruby/jruby-rack.git
318315
cd jruby-rack
319316
```
320317

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

324320
Build the .jar using Maven :
325321

326322
```shell
327-
mvn install
323+
./mvnw install
328324
```
329325

330326
the generated jar should be located at **target/jruby-rack-*.jar**
@@ -342,11 +338,11 @@ package and push the .jar every time a commit changes a source file).
342338

343339
## Releasing
344340

345-
* Make sure auth is configured for "central" repository ID in your .m2/settings.xml
346-
* Update the version in src/main/ruby/jruby/rack/version.rb to the release version
347-
* mvn release:prepare
348-
* mvn release:perform (possibly with -DuseReleaseProfile=false due to Javadoc doclint failures for now)
349-
* rake clean gem SKIP_SPECS=true and push the gem
341+
* Make sure auth is configured for "central" repository ID in your `.m2/settings.xml`
342+
* Update the version in `src/main/ruby/jruby/rack/version.rb` to the release version
343+
* `./mvnw release:prepare`
344+
* `./mvnw release:perform` (possibly with `-DuseReleaseProfile=false` due to Javadoc doclint failures for now)
345+
* `rake clean gem SKIP_SPECS=true` and push the gem
350346

351347
## Adding testing for new Rails versions
352348

@@ -364,13 +360,12 @@ package and push the .jar every time a commit changes a source file).
364360

365361
## Support
366362

367-
Please use [github][4] to file bugs, patches and/or pull requests.
368-
More information at the [wiki][5] or ask us at **#jruby**'s IRC channel.
363+
Please use [github][3] to file bugs, patches and/or pull requests.
364+
More information at the [wiki][4] or ask us at **#jruby**'s IRC channel.
369365

370366
[1]: https://github.com/jruby/warbler#warbler--
371-
[2]: https://oss.sonatype.org/content/repositories/releases/org/jruby/rack/jruby-rack/
372-
[3]: https://github.com/trinidad/trinidad
373-
[4]: https://github.com/jruby/jruby-rack/issues
374-
[5]: https://wiki.github.com/jruby/jruby-rack
375-
[8]: http://badge.fury.io/rb/jruby-rack
376-
[9]: https://github.com/jruby/jruby-rack/actions/workflows/maven.yml
367+
[2]: https://central.sonatype.com/artifact/org.jruby.rack/jruby-rack
368+
[3]: https://github.com/jruby/jruby-rack/issues
369+
[4]: https://github.com/jruby/jruby-rack/wiki
370+
[5]: http://badge.fury.io/rb/jruby-rack
371+
[6]: https://github.com/jruby/jruby-rack/actions/workflows/maven.yml

0 commit comments

Comments
 (0)