Merge pull request #40 from cursorinsight/denes-rename-package

chore: Rename the package to ci-trap-web

Dockerfile

@@ -5,13 +5,13 @@
 #
 # Use the following command to build the image:
 #
-#     $ docker build --ssh default --build-arg GIT_USER=build . -t ci-trap
+#     $ docker build --ssh default --build-arg GIT_USER=build . -t ci-trap-web
 #
 # Replace `build` with your Git user to be able to clone sources from Gerrit.
 #
 # Then run the built image with:
 #
-#     $ docker run --rm -p 8080:80 --name ci-trap ci-trap
+#     $ docker run --rm -p 8080:80 --name ci-trap-web ci-trap-web
 #
 # Your static asset server with `trap.min.js` and `gt.min.js` assets will be
 # available at https://docker-server:8080/.

README.md

@@ -10,19 +10,19 @@ a website do the following in your ES6 or CommonJS compatible project:
 **1. Install:**
 
 ```shell
-$ npm install ci-trap
+$ npm install ci-trap-web
 ```
 
 **2. Import `trap` client using ES6 module syntax:**
 
 ```javascript
-import trap from 'ci-trap';
+import trap from 'ci-trap-web';
 ```
 
 **... or using CommonJS syntax:**
 
 ```javascript
-const { trap } = require('ci-trap');
+const { trap } = require('ci-trap-web');
 ```
 
 **3. Set up data collection server and start collecting events:**
@@ -84,7 +84,7 @@ The UI of the example is available at http://localhost:3000/.
 
 ## Configuration
 
-You can configure `ci-trap` by specifying environment variables during build
+You can configure `ci-trap-web` by specifying environment variables during build
 time. These environment variables act as configuration parameters.
 
 You can find the configuration parameters in `src/constants.js`. Each
@@ -132,7 +132,8 @@ Node.js and its dependencies.
 2.  Build JavaScript asset files with the Docker environment provided:
 
     ```
-    $ docker build --ssh default --build-arg GIT_USER=${GIT_USER} . -t ci-trap
+    $ docker build --ssh default --build-arg GIT_USER=${GIT_USER} . \
+        -t ci-trap-web
     ```
 
     Replace `${GIT_USER}` with your Gerrit/Git user.
@@ -144,7 +145,7 @@ Node.js and its dependencies.
     -   Start the container:
 
         ```
-        $ docker run --rm -p 8080:80 --name ci-trap ci-trap
+        $ docker run --rm -p 8080:80 --name ci-trap-web ci-trap-web
         ```
 
     -   In a separate shell, use `curl` to fetch the asset:
@@ -156,11 +157,11 @@ Node.js and its dependencies.
     -   Or directly copy the file out of it:
 
         ```
-        $ docker cp ci-trap:/opt/app/gt.min.js ./gt.min.js
+        $ docker cp ci-trap-web:/opt/app/gt.min.js ./gt.min.js
         ```
 
 ## License
 
-`ci-trap` is released under the [MIT license].
+`ci-trap-web` is released under the [MIT license].
 
 [MIT license]: https://github.com/cursorinsight/ci-trap/blob/master/LICENSE

examples/es6/package.json

@@ -2,7 +2,7 @@
   "name": "ci-trap-example-esm",
   "version": "1.0.0",
   "private": true,
-  "description": "ESM example for ci-trap",
+  "description": "ESM example for ci-trap-web",
   "scripts": {
     "serve": "webpack serve --config webpack.config.js --hot"
   },
@@ -13,7 +13,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "ci-trap": "file:../../"
+    "ci-trap-web": "file:../../"
   },
   "devDependencies": {
     "babel-loader": "^9.1.2",

examples/es6/src/trap-esm.js

@@ -1,4 +1,4 @@
-import trap from 'ci-trap';
+import trap from 'ci-trap-web';
 import './style.css';
 
 // Mount Trap's event listener and disable touch events

examples/sandbox/package.json

@@ -2,7 +2,7 @@
   "name": "ci-trap-example-research",
   "version": "1.0.0",
   "private": true,
-  "description": "Research example for ci-trap",
+  "description": "Research example for ci-trap-web",
   "scripts": {
     "serve": "webpack serve --config webpack.config.js --hot"
   },
@@ -13,7 +13,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "ci-trap": "file:../../"
+    "ci-trap-web": "file:../../"
   },
   "devDependencies": {
     "babel-loader": "^9.1.2",

examples/sandbox/src/index.js

@@ -1,4 +1,4 @@
-import trap from 'ci-trap';
+import trap from 'ci-trap-web';
 import './style.css';
 
 // Mount Trap's event listener and disable touch events

examples/vanilla/Dockerfile

@@ -18,7 +18,7 @@
 # https://docker-server:8080/.
 
 # Source image name
-ARG CI_TRAP_IMAGE_NAME=ci-trap
+ARG CI_TRAP_IMAGE_NAME=ci-trap-web
 
 # Source image tag
 ARG CI_TRAP_IMAGE_TAG=latest

examples/vanilla/package.json

@@ -13,7 +13,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "ci-trap": "file:../../"
+    "ci-trap-web": "file:../../"
   },
   "devDependencies": {
     "babel-loader": "^9.1.2",

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "ci-trap",
+  "name": "ci-trap-web",
   "version": "1.0.4",
   "description": "Lightweight mouse and touch event tracker library for browsers.",
   "main": "dist/trap-umd.min.js",

sonar-project.properties

@@ -1,10 +1,10 @@
 # must be unique in a given SonarQube instance
-sonar.projectKey=cursor-insight:ci-trap
+sonar.projectKey=cursor-insight:ci-trap-web
 
 # --- optional properties ---
 
 # defaults to project key
-sonar.projectName=ci-trap
+sonar.projectName=ci-trap-web
 
 # defaults to 'not provided'
 #sonar.projectVersion=1.0