@abw/badger 1.0.0 → 1.0.1

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/README.md CHANGED
@@ -3,7 +3,34 @@
3
3
  This is an application toolkit for Javascript projects. It provides a number of
4
4
  classes and utility functions to make life easier.
5
5
 
6
- It is loosely based around the [https://github.com/abw/Badger](Badger) toolkit for
7
- Perl.
6
+ It is loosely based around the [Badger](https://github.com/abw/Badger) toolkit for
7
+ Perl and was written primarily to help migrate some old Perl projects to Javascript.
8
8
 
9
- It was written to help migrate some old Perl projects to Javascript.
9
+ ## Installation
10
+
11
+ Install `badger` using your favourite package manager.
12
+
13
+ ### npm
14
+
15
+ npm install @abw/badger
16
+
17
+ ### pnpm
18
+
19
+ pnpm install @abw/badger
20
+
21
+ ### yarn
22
+
23
+ yarn add @abw/badger
24
+
25
+ ## Manual
26
+
27
+ Read the [Manual](https://abw.github.io/badger-js/docs/manual/) for an introduction to the
28
+ toolkit and example of use.
29
+ ## API Documentation
30
+
31
+ Read the [API documentation](https://abw.github.io/badger-js/docs/) for further information
32
+ about the classes, methods and utility functions provided.
33
+
34
+ ## Author
35
+
36
+ Andy Wardley <abw@wardley.org>