@guardian/ophan-tracker-js 2.1.0-next.0 → 2.1.0-next.2

package/readme.md

@@ -10,7 +10,7 @@ $ npm install ophan-tracker-js
 
 ## Contribute
 
-#### Proxy tracker-ts:
+#### Proxy tracker-js:
 
 1. Install dependencies
 
@@ -19,28 +19,22 @@ $ npm install ophan-tracker-js
     .../ophan/tracker-js $ npm install
     ```
 
-2. In one terminal window:
-
-    ```
-    .../ophan/tracker-js $ npm run coffee-to-esm:watch
-    ```
-
-3. In another terminal window:
+2. In another terminal window:
 
     ```
     .../ophan/tracker-js $ lighttpd -f lighttpd.conf -D
     ```
 
-4. Install FoxyProxy (https://getfoxyproxy.org/downloads/) in your browser and create a rule that forces j.ophan.co.uk 
+3. Install FoxyProxy (https://getfoxyproxy.org/downloads/) in your browser and create a rule that forces j.ophan.co.uk 
 to localhost 8000. (For me FoxyProxy needed a few switches on and off before it decided to start talking to lighttpd.)
 
-5. In another terminal window, start a server that is [running the Guardian frontend](https://github.com/guardian/frontend/blob/main/docs/01-start-here/01-installation-steps.md)
+4. In another terminal window, start a server that is [running the Guardian frontend](https://github.com/guardian/frontend/blob/main/docs/01-start-here/01-installation-steps.md)
 
-6. Navigate to where you are running the Guardian locally (e.g. https://localhost:9000/uk)
+5. Navigate to where you are running the Guardian locally (e.g. https://localhost:9000/uk)
 
-7. Ensure FoxyProxy is enabled
+6. Ensure FoxyProxy is enabled
 
-8. Develop with pleasure
+7. Develop with pleasure
 
 ## Publish
 
@@ -62,8 +56,14 @@ We use `changesets` for automated publishing of the NPM package:
    
 3. When the PR is merged, the [`changesets` github action](https://github.com/changesets/action) will create a new PR, [example here](https://github.com/guardian/ophan/pull/5626). On merging this generated PR, the action will publish to NPM. (This checks the subdirectory correctly.)
 
-_Note:_ This seems like an unnecessary extra step and another PR to merge. This action is useful for multi-package repos, and packages with more frequent changes where it consolidates changes from multiple PR's into a single release. This therefore does not apply to us, but we've had issues publishing straight to NPM via the initial action on merge to main.
-
 ##### S3 Bucket
 
 * [https://j.ophan.co.uk/](https://j.ophan.co.uk/jobs.js) - CDN/S3, [deployed through RiffRaff](https://riffraff.gutools.co.uk/deployment/history?projectName=ophan%3A%3Aophan-tracker-js&page=1) and used by some Guardian sites like https://jobs.theguardian.com/. An advantage of this approach is that sites using it immediately get Tracker JS updates, without developer intervention.
+
+##### Rollup
+
+The generated files from Rollup are only used for publishing to the CDN to use SystemJS / AMD
+
+##### Example Usage
+
+You can see example usage of the library on theguardian.com [here](https://github.com/guardian/dotcom-rendering/blob/main/dotcom-rendering/src/client/ophan/ophan.ts)