summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJannis R <mail@jannisr.de>2020-10-16 18:10:38 +0200
committerJannis R <mail@jannisr.de>2020-10-16 18:11:00 +0200
commit2f13bd7349b798e4afd5693f6a258a56e30cf13d (patch)
tree3d7c66e9a1c015ff6850fa7eac2ce2701285d050
parent0fdbefbb86bcf959875358b732682af65eddacc2 (diff)
minor tweaks, 1.0.4
also add @RangerMauve as contributor [ci skip]
-rw-r--r--package.json5
-rw-r--r--readme.md11
2 files changed, 13 insertions, 3 deletions
diff --git a/package.json b/package.json
index db4432f..72316c9 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "@derhuerst/gemini",
"description": "Experimental Gemini server & client.",
- "version": "1.0.3",
+ "version": "1.0.4",
"main": "index.js",
"files": [
"index.js",
@@ -18,6 +18,9 @@
"server"
],
"author": "Jannis R <mail@jannisr.de>",
+ "contributors": [
+ "<RangerMauve@hotmail.com>"
+ ],
"homepage": "https://github.com/derhuerst/gemini",
"repository": "derhuerst/gemini",
"bugs": "https://github.com/derhuerst/gemini/issues",
diff --git a/readme.md b/readme.md
index 43937cf..1017738 100644
--- a/readme.md
+++ b/readme.md
@@ -99,6 +99,8 @@ request('/foo', {
## API
+### `createServer`
+
```js
const createServer = require('@derhuerst/gemini/server')
createServer(opt = {}, onRequest)
@@ -115,7 +117,7 @@ createServer(opt = {}, onRequest)
}
```
----
+### `request`
```js
const request = require('@derhuerst/gemini/client')
@@ -137,7 +139,7 @@ request(pathOrUrl, opt = {}, cb)
}
```
----
+### `connect`
```js
const connect = require('@derhuerst/gemini/connect')
@@ -158,6 +160,11 @@ connect(opt = {}, cb)
```
+## Related
+
+- [`gemini-fetch`](https://github.com/RangerMauve/gemini-fetch) – Load data from the Gemini protocol the way you would fetch from HTTP in JavaScript
+
+
## Contributing
If you have a question or need support using `gemini`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, use [the issues page](https://github.com/derhuerst/gemini/issues).