title-switcher 2.1.14 → 2.1.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.md CHANGED
File without changes
package/README.md CHANGED
@@ -61,3 +61,17 @@ Live example at https://joshuaheagle.com/projects/title-switcher. Enjoy!
61
61
  randomTitles.startTitles({ isRandom: true })
62
62
  ```
63
63
 
64
+ ## Documentation
65
+
66
+ The reference for the `TitleSwitcher` class is in [`docs/`](https://joshuaheagle.com/projects/title-switcher/docs/index.html) (or open `docs/index.html` locally), generated from the TypeScript source in `src/main.ts`.
67
+
68
+ ## Development
69
+
70
+ ```shell
71
+ npm install
72
+ npm test # the tests
73
+ npm run typecheck # the types
74
+ npm run build # dist/, browser/ and docs/
75
+ npm run docs # only the documentation
76
+ ```
77
+