Merge pull request #1207 from projectblacklight/publish-to-npm

Update package.json so we can publish sass source files to NPM

Author: marlo-longley

README.md

@@ -107,13 +107,20 @@ Then visit http://localhost:3000. It will also start a Solr instance on port 898
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-### Release a new version of the gem
+### Releasing
 
-To release a new version:
+#### To release a new gem:
 
 1. Update the version number in `lib/arclight/version.rb`
 2. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, build the gem file (e.g., `gem build arclight.gemspec`) and push the `.gem` file to [rubygems.org](https://rubygems.org) (e.g., `gem push arclight-x.y.z.gem`).
 
+#### To release the frontend sources:
+
+When any of the javascript components or SASS sources in the gem are changed, this package should be published to NPM with the following steps:
+1. [Install npm](https://www.npmjs.com/get-npm)
+2. Bump the version number in `package.json`
+3. run `npm publish` to push the javascript package to https://npmjs.org/package/arclight
+
 ## Contributing
 
 [Bug reports](https://github.com/projectblacklight/arclight/issues) and [pull requests](https://github.com/projectblacklight/arclight/pulls) are welcome on ArcLight -- see [CONTRIBUTING.md](https://github.com/projectblacklight/arclight/blob/main/CONTRIBUTING.md) for details.

package.json

@@ -1,7 +1,11 @@
 {
   "name": "arclight",
-  "description": "",
-  "main": "index.js",
+  "version": "1.0.0-pre.1",
+  "description": "The frontend for arclight",
+  "main": "app/assets/javascript/arclight/arclight.js",
+  "files": [
+    "app/assets"
+  ],
   "devDependencies": {
     "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^11.1.3",