Merge pull request #7 from VilledeMontreal/develop

Fix examples by removing scoped dependencies

Author: joscelynjean

README.md

@@ -34,12 +34,20 @@ For examples, check the `examples` folder.
 Install the dependency.
 
 ```
-$ npm install @villedemontreal/idempotency-express
+$ npm install express-idempotency
 ```
 
 Integrate the middleware in your Express initialization.
 
 ```javascript
+// Javascript
+const idempotency = require('express-idempotency');
+// ...express initialization
+app.post('*', idempotency.idempotency());
+
+// Typescript
+import { idempotency } from 'express-idempotency';
+// ...express initialization
 app.post('*', idempotency());
 ```
 
@@ -180,12 +188,20 @@ Pour des exemples, voir le répertoire `examples`.
 Installation de la dépendance.
 
 ```
-$ npm install @villedemontreal/idempotency-express
+$ npm install express-idempotency
 ```
 
 Intégrer le middleware dans l'initialisation de votre application Express.
 
 ```javascript
+// Javascript
+const idempotency = require('express-idempotency');
+// ...initialisation de Express
+app.post('*', idempotency.idempotency());
+
+// Typescript
+import { idempotency } from 'express-idempotency';
+// ...initialisation de Express
 app.post('*', idempotency());
 ```
 

examples/simple-use/Dockerfile

@@ -11,7 +11,7 @@ RUN npm install && npm run compile && npm link
 
 # Installation of package to run the application
 WORKDIR /usr/src/app/examples/simple-use
-RUN npm link "@villemontreal/express-idempotency" && npm install
+RUN npm link "express-idempotency" && npm install
 
 EXPOSE 8080
 

examples/simple-use/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@villemontreal/express-idempotency-example",
+  "name": "express-idempotency-example",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
@@ -9,7 +9,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@villemontreal/express-idempotency": "1.0.0",
+    "express-idempotency": "1.0.2",
     "express": "^4.17.1"
   }
-}
+}

examples/simple-use/src/index.js

@@ -4,23 +4,23 @@
 
 const express = require('express');
 const app = express();
-const idempotency = require('@villemontreal/express-idempotency');
+const idempotency = require('express-idempotency');
 
 app.use(idempotency.idempotency());
 
 app.all('/', function (req, res) {
-  const idempotencyService = idempotency.getSharedIdempotencyService();
-  if (idempotencyService.isHit(req)) {
-    console.log('Idempotency middleware did already process the request!');
-    return;
-  }
+    const idempotencyService = idempotency.getSharedIdempotencyService();
+    if (idempotencyService.isHit(req)) {
+        console.log('Idempotency middleware did already process the request!');
+        return;
+    }
 
-  // Return the current date and time
-  res.send(new Date().toISOString());
+    // Return the current date and time
+    res.send(new Date().toISOString());
 });
 
 app.listen(8080, function () {
-  console.log(
-    'Example app listening on port 8080 with express-idempotency middleware.'
-  );
-});
+    console.log(
+        'Example app listening on port 8080 with express-idempotency middleware.'
+    );
+});

package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-idempotency",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",