Sync from Simplified PR #350 / commit 6f88c82

CHANGELOG.md

@@ -1,5 +1,38 @@
 ## Changelog
 
+#### (Prerelease) Updated
+
+- Updated the README.
+- Added a Github pull request template.
+
+### v0.5.1
+
+#### Fixed
+
+- Made footer consistent across pages.
+- Ensured footer was not covering other page elements.
+
+#### Updated
+
+- Updated the opds-web-client to version 0.6.2.
+
+### v0.5.0
+
+#### Updated
+
+- Updated `opds-web-client` to version `^0.6.1`.
+
+#### Fixed
+
+- Updated npm packages to fix security issues.
+- Minor updates to types to run and build the project.
+
+### v0.4.41
+
+#### Added
+
+- Added a custom Mocha reporter so that a formatted list of suites and tests can be generated via the CLI.
+
 ### v0.4.40
 
 #### Fixed

README.md

@@ -8,19 +8,19 @@ This is a [LYRASIS](http://lyrasis.org)-maintained fork of the NYPL [Library Sim
 
 To see screenshots, read in-depth documentation, and find out more about the project, check out the [Confluence](https://confluence.nypl.org/display/SIM/) site hosted by The New York Public Library.
 
-## Setup
+## Set Up
 
-This package is meant to be used with the Library Simplified [Circulation Manager](https://github.com/NYPL-Simplified/circulation).
+This package is meant to be used with the Library Simplified [Circulation Manager](https://github.com/NYPL-Simplified/circulation), and cannot be run in isolation. Please follow the Circulation Manager README instructions before setting up this repository.
 
-#### Use npm version
+#### Use npm Version
 
 Suggested local folder setup:
 
 - `/[path to project folder]/circulation`
 
 To use the published version with your circulation manager, run `npm install` from `api/admin` in the `circulation` local installed repository.
 
-#### Use local development version
+#### Use Local Development Version
 
 Suggested local folder setup:
 
@@ -30,22 +30,33 @@ Suggested local folder setup:
 If you're working on the administrative interface and want to test local changes, you can link your local clone of this repository to your local circulation manager. These steps will allow you to work on the front-end administrative interface and see updates while developing.
 
 1. Run `npm link` in this `circulation-web` repository,
-2. run `npm link simplified-circulation-web` from `api/admin` in the `circulation` repository,
+2. run `npm link simplified-circulation-web` from `api/admin` in the `circulation` repository (which is where package.json is located),
 3. run the circulation manager using `python app.py` at the root in the `circulation` repository,
 4. run the web interface using `npm run dev` at the root of this `circulation-web` repository,
-5. visit `localhost:6500/admin/`
+5. run the Elasticsearch server using `./bin/elasticsearch` in the elasticsearch-[version] directory,
+6. visit `localhost:6500/admin/`.
 
-Webpack will take care of compiling and updating any new changes made locally for development. Just refresh the page to see updates without having to restart either the `circulation` or `circulation-web` servers.
+Webpack will take care of compiling and updating any new changes made locally for development. Just hard refresh the page (command + shift + R) to see updates without having to restart either the `circulation` or `circulation-web` servers.
 
 ## Web Catalog
 
-The Circulation Manager administrative interface relies on the [OPDS Web Catalog](https://github.com/NYPL-Simplified/opds-web-client) as its base React component and application. For more information, please check out the repository.
+The Circulation Manager administrative interface relies on the [OPDS Web Catalog](https://github.com/NYPL-Simplified/opds-web-client) as its base React component and application. For more information, please check out that repository.
 
-## Publishing
+## Publishing a New Release
 
-This package is [published to npm](https://www.npmjs.com/package/simplified-circulation-web).
+Before publishing a new release, update the version number in package.json and add the new version number + comments about what the new version includes to CHANGELOG.md. For new version numbers, you can refer to [Semantic Versioning](https://semver.org/) (major.minor.patch). Then, run `npm install` to update the package-lock.json file to include the new version.
 
-To publish a new version, you need to create an npm account and be a collaborator on the package. Then you can run `npm publish` from your local copy of the repository.
+Commit your changes, push them to Github, make a PR, and request your reviewer. Once approved, you may go back to your local repository, checkout the main branch, and `git pull`.
+
+This package is [published to npm](https://www.npmjs.com/package/simplified-circulation-web). To publish a new version, you need to create an npm account and be a collaborator on the package.
+
+If you're not already logged in to npm from your terminal, you'll have to do so at this point. Run `npm login` and enter your credentials when prompted.
+
+Then, you can run `npm publish` from your local copy of the repository (ensure you are on the main branch before doing so).
+
+Afterwards, you should tag the release and add comments to Github. On the main branch, run `git tag -a v[version number] -m '[commit message]'`. Then run `git push origin v[version number]`.
+
+Go to the Github repository, click on "tags," find the tag you pushed, click on it and hit "edit." Add a release title, and a description. Then save by clicking, "Update Release."
 
 ## Accessibility