Skip to content

Commit a7dde1a

Browse files
committed
Update README and package.json description
1 parent ea32eee commit a7dde1a

File tree

3 files changed

+23
-14
lines changed

3 files changed

+23
-14
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,18 @@
11
# human-connection-api-nodejs-client
2-
Human Connection Node.js API Client
2+
3+
Have a local Human Connection API server running on [port 3030](http:://localhost:3030), see [instructions](https://github.com/Human-Connection/API).
4+
5+
Make sure you have [node](https://nodejs.org/en/) installed with a version >= 9.0.0.
6+
7+
Then run:
8+
9+
```sh
10+
node --experimental-modules index.mjs
11+
12+
```
13+
14+
Or
15+
```sh
16+
yarn start
17+
```
18+
if you have yarn installed.

README.md_

Lines changed: 0 additions & 10 deletions
This file was deleted.

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22
"dependencies": {
33
"node-fetch": "^2.1.2"
44
},
5-
"name": "human-connection-glue-code",
5+
"name": "human-connection-api-nodejs-client",
66
"version": "1.0.0",
7-
"description": "Glue code between social network Human Connection and digital democracy app Democracy",
7+
"description": "Human Connection Node.js API Client",
88
"main": "index.mjs",
99
"repository": "https://github.com/roschaefer/human-connection-glue-code",
1010
"author": "Robert Schaefer <[email protected]>",
11-
"license": "MIT"
11+
"license": "MIT",
12+
"scripts": {
13+
"start" : "node --experimental-modules index.mjs"
14+
}
1215
}

0 commit comments

Comments
 (0)