@internetarchive/collection-browser 3.3.0 → 3.3.1-alpha3

package/README.md

@@ -1,84 +1,84 @@
-![Build Status](https://github.com/internetarchive/iaux-collection-browser/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/internetarchive/iaux-collection-browser/branch/main/graph/badge.svg?token=CLWEGO4RMQ)](https://codecov.io/gh/internetarchive/iaux-collection-browser)
-
-
-# Internet Archive Collection Browser
-
-This is the main collection browser for the Internet Archive website.
-
-[Review app URL](https://internetarchive.github.io/iaux-collection-browser/main) 
-## Usage
-
-```ts
-import '@internetarchive/collection-browser';
-
-<collection-browser>
-</collection-browser>
-```
-
-## Local Demo with `web-dev-server`
-```bash
-yarn install
-yarn start
-```
-To run a local development server that serves the basic demo located in `index.html`
-
-## Testing with Web Test Runner
-To run the suite of Web Test Runner tests, run
-```bash
-yarn run test
-```
-
-To run the tests in watch mode (for &lt;abbr title=&#34;test driven development&#34;&gt;TDD&lt;/abbr&gt;, for example), run
-
-```bash
-yarn run test:watch
-```
-
-## Linting with ESLint, Prettier, and Types
-To scan the project for linting errors, run
-```bash
-yarn run lint
-```
-
-You can lint with ESLint and Prettier individually as well
-```bash
-yarn run lint:eslint
-```
-```bash
-yarn run lint:prettier
-```
-
-To automatically fix many linting errors, run
-```bash
-yarn run format
-```
-
-You can format using ESLint and Prettier individually as well
-```bash
-yarn run format:eslint
-```
-```bash
-yarn run format:prettier
-```
-
-## Tooling configs
-
-For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
-
-If you customize the configuration a lot, you can consider moving them to individual files.
-
-## Manual Deploy using `gh-pages`
-
-Live demo app from current main branch: [https://internetarchive.github.io/iaux-collection-browser](https://internetarchive.github.io/iaux-collection-browser)
-
-```
-yarn run deploy
-```
-
-## Automatic Deploy of Demo App
-
-When you create a Pull Request, if your code passes codecov unit tests, it will be always served live at base url / pull request number. For this demo app, you must create a Pull Request, nothing will be created from a simple branch.
-
-This URL will be removed when the Pull Request is merged/closed.
-
+![Build Status](https://github.com/internetarchive/iaux-collection-browser/actions/workflows/ci.yml/badge.svg) [![codecov](https://codecov.io/gh/internetarchive/iaux-collection-browser/branch/main/graph/badge.svg?token=CLWEGO4RMQ)](https://codecov.io/gh/internetarchive/iaux-collection-browser)
+
+
+# Internet Archive Collection Browser
+
+This is the main collection browser for the Internet Archive website.
+
+[Review app URL](https://internetarchive.github.io/iaux-collection-browser/main) 
+## Usage
+
+```ts
+import '@internetarchive/collection-browser';
+
+<collection-browser>
+</collection-browser>
+```
+
+## Local Demo with `web-dev-server`
+```bash
+yarn install
+yarn start
+```
+To run a local development server that serves the basic demo located in `index.html`
+
+## Testing with Web Test Runner
+To run the suite of Web Test Runner tests, run
+```bash
+yarn run test
+```
+
+To run the tests in watch mode (for &lt;abbr title=&#34;test driven development&#34;&gt;TDD&lt;/abbr&gt;, for example), run
+
+```bash
+yarn run test:watch
+```
+
+## Linting with ESLint, Prettier, and Types
+To scan the project for linting errors, run
+```bash
+yarn run lint
+```
+
+You can lint with ESLint and Prettier individually as well
+```bash
+yarn run lint:eslint
+```
+```bash
+yarn run lint:prettier
+```
+
+To automatically fix many linting errors, run
+```bash
+yarn run format
+```
+
+You can format using ESLint and Prettier individually as well
+```bash
+yarn run format:eslint
+```
+```bash
+yarn run format:prettier
+```
+
+## Tooling configs
+
+For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
+
+If you customize the configuration a lot, you can consider moving them to individual files.
+
+## Manual Deploy using `gh-pages`
+
+Live demo app from current main branch: [https://internetarchive.github.io/iaux-collection-browser](https://internetarchive.github.io/iaux-collection-browser)
+
+```
+yarn run deploy
+```
+
+## Automatic Deploy of Demo App
+
+When you create a Pull Request, if your code passes codecov unit tests, it will be always served live at base url / pull request number. For this demo app, you must create a Pull Request, nothing will be created from a simple branch.
+
+This URL will be removed when the Pull Request is merged/closed.
+
 Example: `https://internetarchive.github.io/iaux-collection-browser/pr/<pr-number>`