Skip to content

Commit b51aff0

Browse files
authored
docs: rework graal vm native image tip [skip ci] (#55)
Be more vague and point to Graal docs. A "known issue" implies a bug, rename to "tip".
1 parent 1e64a91 commit b51aff0

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
A Clojure HTTP library similar to [clj-http](http://github.com/dakrone/clj-http), but more lightweight. Compatible with Babashka and GraalVM.
44

5-
> This is a clj-commons maintained fork of the original [`hiredman/clj-http-lite`](https://github.com/hiredman/clj-http-lite) repo.
5+
> This is a clj-commons maintained fork of the archived [`hiredman/clj-http-lite`](https://github.com/hiredman/clj-http-lite) repo.
66
7-
[Installation](#installation) | [Usage](#usage) | [Known Issues](#known-issues) | [Design](#design) | [Development](#development)
7+
[Installation](#installation) | [Usage](#usage) | [Design](#design) | [Development](#development)
88

99
## Installation
1010

@@ -240,17 +240,11 @@ If you need to fake clj-http responses (for things like testing and
240240
such), check out the
241241
[clj-http-fake](https://github.com/myfreeweb/clj-http-fake) library.
242242

243-
## Known Issues
243+
## GraalVM Native Image Tips
244244

245-
- If you issue HTTPS connections, [Native Image](https://www.graalvm.org/docs/reference-manual/native-image/) compilation requires an additional parameter in order to enable its support in the generated image.
245+
You'll need to enable url protocols when building your native image.
246246

247-
If you get the following kind of error:
248-
249-
Exception in thread "main" java.net.MalformedURLException: Accessing an URL protocol that was not enabled.
250-
The URL protocol https is supported but not enabled by default. It must be enabled by adding the
251-
-H:EnableURLProtocols=https option to the native-image command.
252-
253-
Then add either `-H:EnableURLProtocols=https` or `--enable-https` option to your compilation step.
247+
See [GraalVM docs](https://www.graalvm.org/22.2/reference-manual/native-image/dynamic-features/URLProtocols/).
254248

255249
## Design
256250

0 commit comments

Comments
 (0)