From b21d9de9ac439790eb361cae4fab26a1afcecf76 Mon Sep 17 00:00:00 2001 From: Francesco Esposito <33671357+frab1t@users.noreply.github.com> Date: Tue, 23 Jul 2019 21:03:14 +0200 Subject: [PATCH] edit user ref --- README.md | 33 +++++++++++++++------------------ package.json | 8 ++++---- 2 files changed, 19 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 9443e17..4c701c2 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,20 @@ A simple REST API for trackmyd. - ## Architecture - + ## Paths & Operations - -| Path | Operation | Description | -|------ |----- |----| -| /devices | GET | Get devices| -| /devices | POST | Add new device | -| /devices?id= | GET | Get single device -| /devices?id= | PATCH | Update device | -| /device?id= | DELETE | Delete device | -| /device?name= | GET | Get single device +| Path | Operation | Description | +| ------------- | --------- | ----------------- | +| /devices | GET | Get devices | +| /devices | POST | Add new device | +| /devices?id= | GET | Get single device | +| /devices?id= | PATCH | Update device | +| /device?id= | DELETE | Delete device | +| /device?name= | GET | Get single device | ## Installation @@ -25,11 +23,10 @@ A simple REST API for trackmyd. 1. Install **NodeJS** and **NPM**. 2. Install **Mongodb**. -2. Clone this repository. -3. Install dependencies with `npm install`. -6. Configure **users** (app.auth.users) basic authentication into `config.json`. -7. Configure database (db) into `config.json`. -8. Start with `npm start`. +3. Clone this repository. +4. Install dependencies with `npm install`. +5. Configure **users** (app.auth.users) basic authentication into `config.json`. +6. Configure database (db) into `config.json`. +7. Start with `npm start`. - - Made with ❤️ by Francesco Esposito ([@frab1t](https://github.com/frab1t)) \ No newline at end of file +Made with ❤️ by Francesco Esposito ([@frsposito](https://github.com/frsposito)) diff --git a/package.json b/package.json index e65293a..8732de1 100644 --- a/package.json +++ b/package.json @@ -9,14 +9,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/frab1t/trackmyd-api.git" + "url": "git+https://github.com/frsposito/trackmyd-api.git" }, - "author": "frab1t", + "author": "frsposito", "license": "GPL-3.0-or-later", "bugs": { - "url": "https://github.com/frab1t/trackmyd-api/issues" + "url": "https://github.com/frsposito/trackmyd-api/issues" }, - "homepage": "https://github.com/frab1t/trackmyd-api#readme", + "homepage": "https://github.com/frsposito/trackmyd-api#readme", "devDependencies": { "eslint": "^5.14.1", "eslint-config-airbnb-base": "^13.1.0",