Skip to content

Commit 65ad92e

Browse files
committed
[docs] update README compatibility, refresh examples
- 0.15.x supports JRuby 9.2 - 10.0, Java 8 - 25, BC 1.78 - 1.83 - Remove defunct Travis CI badge - Update Maven Central URL (http -> https, new domain) - Update example JRuby/BC versions to current - (c) 2026
1 parent bc49456 commit 65ad92e

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

README.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
[JRuby-OpenSSL](https://github.com/jruby/jruby-openssl) is an add-on gem for
44
[JRuby](https://www.jruby.org/) that emulates the Ruby OpenSSL native library.
55

6-
Under the hood uses the [Bouncy Castle Crypto APIs](https://www.bouncycastle.org/java.html).
6+
Under the hood it uses the [Bouncy Castle Crypto APIs](https://www.bouncycastle.org/java.html).
77

8-
Each jruby-openssl gem release includes a certain version, usually the latest available,
9-
of the library (namely BC Provider and PKIX/CMS/EAC/PKCS/OCSP/TSP/OPENSSL jars).
8+
Each jruby-openssl gem release includes the Bouncy Castle library (BC Provider and
9+
PKIX/CMS/EAC/PKCS/OCSP/TSP/OPENSSL jars), usually the latest available version.
1010

1111
Please report bugs and incompatibilities (preferably with test-cases) to either
1212
the JRuby [mailing list][1] or the [bug tracker][2].
@@ -28,48 +28,46 @@ the JRuby [mailing list][1] or the [bug tracker][2].
2828
| ~>0.12.x | 9.1.x-9.3.x | Java 8-15 | 1.65-1.68 |
2929
| ~>0.13.x | 9.1.x-9.4.x | Java 8-17 | 1.68-1.69 |
3030
| ~>0.14.x | 9.1.x-9.4.x | Java 8-21 | 1.71-1.74 |
31-
| ~>0.15.x | 9.2.x-9.4.x | Java 8-21 | 1.76-1.79 |
31+
| ~>0.15.x | 9.2.x-10.0.x | Java 8-25 | 1.78-1.83 |
3232

33-
NOTE: backwards JRuby compatibility was not handled for versions <= **0.9.6**
33+
NOTE: backwards JRuby compatibility was not handled for versions <= **0.9.6**
3434

3535
## Security
3636

37-
JRuby-OpenSSL is an essential part of [JRuby](https://www.jruby.org/), please report security vulnerabilities to
37+
JRuby-OpenSSL is an essential part of [JRuby](https://www.jruby.org/), please report security vulnerabilities to
3838
`security@jruby.org` as detailed on JRuby's [security page](https://www.jruby.org/security) or using [GitHub][0].
39-
40-
Please note that most OpenSSL vulnerabilities do not effect JRuby since its not using
41-
any of OpenSSL's C code, only Ruby parts (*.rb) are the same as in MRI's OpenSSL library.
4239

43-
## Testing
40+
Please note that most OpenSSL vulnerabilities do not affect JRuby since it's not using
41+
any of OpenSSL's C code, only Ruby parts (*.rb) are the same as in MRI's OpenSSL library.
4442

45-
[![Build Status][0]](http://travis-ci.org/jruby/jruby-openssl)
43+
## Testing
4644

4745
rake jar:all # creates pom.xml and generates jopenssl.jar under lib
4846
mvn test
4947

50-
will run (junit as well as ruby) tests and a some ruby tests against the default
51-
jruby version. to pick a different JRuby version run
48+
This will run (JUnit as well as Ruby) tests against the default JRuby version.
49+
To pick a different JRuby version:
5250

53-
mvn test -Djruby.versions=9.2.8.0
51+
mvn test -Djruby.versions=9.4.14.0
5452

55-
for running integration-tests the gem will be first installed and then the same
56-
tests run for each possible bouncy-castle version (see [listing][3]), run with
53+
For running integration tests the gem will be installed first and the same
54+
tests run for each supported Bouncy Castle version (see [listing][3]):
5755

58-
mvn verify -P test-9.2.9.0,test-9.1.17.0
56+
mvn verify -P test-9.4.14.0,test-9.2.21.0
5957

60-
or pick a bouncy-castle version
58+
Or pick a specific Bouncy Castle version:
6159

62-
mvn verify -P test-9.2.9.0 -Dbc.versions=1.60
60+
mvn verify -P test-9.4.14.0 -Dbc.versions=1.78
6361

64-
NOTE: you can pick any jruby version which is on [central][4] or on [ci.jruby][5]
62+
NOTE: you can pick any JRuby version which is on [Maven Central][4] or on [ci.jruby][5]
6563

6664
## License
6765

68-
(c) 2009-2024 JRuby distributed under EPL 1.0/GPL 2.0/LGPL 2.1
66+
(c) 2009-2026 JRuby distributed under EPL 1.0/GPL 2.0/LGPL 2.1
6967

7068
[0]: https://github.com/jruby/jruby-openssl/security
7169
[1]: https://github.com/jruby/jruby/wiki/MailingLists
7270
[2]: https://github.com/jruby/jruby-openssl/issues/new
7371
[3]: https://github.com/jruby/jruby-openssl/tree/master/integration
74-
[4]: http://central.maven.org/maven2/org/jruby/
72+
[4]: https://repo1.maven.org/maven2/org/jruby/
7573
[5]: https://www.jruby.org/nightly

0 commit comments

Comments
 (0)