Skip to content

Commit 38a1867

Browse files
fixed badge issue
1 parent 9d439f3 commit 38a1867

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,23 @@
55

66
<p align="center">
77
<a href="https://travis-ci.org/HumanConnection/HC-API"><img src="https://img.shields.io/travis/HumanConnection/HC-API/master.svg" alt="Build Status"></a>
8+
<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img src="https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-green.svg" "Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)" /></a>
89
</p>
910

10-
# Human Connection API
11+
# Human-Connection API
1112

12-
The API for a better world. More information under [humanconnection.org](https://humanconnection.org)
13+
The API for a better world. More information under [human-connection.org](https://human-connection.org)
1314

14-
> **Note:** This is only the API part of Human Connection, you can also checkout the Frontend which uses this API.
15+
> **Note:** This is only the API part of Human-Connection, you have to also checkout the [Frontend](https://github.com/HumanConnection/HC-Frontend) which uses this API.
1516
1617
## Framework
1718

1819
This project uses [Feathers](http://feathersjs.com). An open source web framework for building modern real-time applications.
1920

2021
## Getting Started
2122

23+
> we recommand to install the project locally for the best development ease and performance
24+
2225
Getting up and running is as easy as 1, 2, 3, 4 ... 5.
2326

2427
1. Make sure you have [NodeJS](https://nodejs.org/), [yarn](https://yarnpkg.com), [mongoDB](https://www.mongodb.com/download-center#community) installed.
@@ -36,7 +39,7 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
3639

3740
4. Setup local mailserver (optional)
3841

39-
> **NOTE:**
42+
> **Note:**
4043
> *You only have to start that mailserver when you want to register, reset your password or test emails in any form, it
4144
> does not affect the rest of the application.*
4245
@@ -105,7 +108,7 @@ The seeder configuration has two properties:
105108
106109
Simply run `yarn test` and all your tests in the `test/` directory will be run.
107110
108-
> **NOTE:**
111+
> **Note:**
109112
> *At the moment there are some issues with linting while testing, but you can run the tests also with mocha run*
110113
111114
## Scaffolding

package.json

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
11
{
2-
"name": "HC-API",
3-
"description": "Human Connection API",
2+
"name": "hc-api",
3+
"description": "Human-Connection API",
44
"version": "0.1.0",
55
"homepage": "https://human-connection.org",
6+
"license": "CC BY-NC-SA 4.0",
7+
"repository": {
8+
"type" : "git",
9+
"url" : "https://github.com/HumanConnection/HC-API.git"
10+
},
611
"main": "server",
712
"keywords": [
8-
"feathers"
13+
"human-connection",
14+
"social network",
15+
"api",
16+
"feathersjs"
917
],
1018
"author": {
1119
"name": "Human Connection gGmbH",
1220
"email": "[email protected]"
1321
},
1422
"contributors": [],
15-
"bugs": {},
23+
"bugs": {
24+
"url" : "https://github.com/HumanConnection/HC-API/issues",
25+
"email" : "[email protected]"
26+
},
1627
"directories": {
1728
"lib": "server",
1829
"test": "test/"

0 commit comments

Comments
 (0)