yapp 4.0.199 → 4.0.200
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 +19 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,6 +10,7 @@ Yet Another Pretty Printer.
|
|
|
10
10
|
|
|
11
11
|
- [Introduction](#introduction)
|
|
12
12
|
- [Installation](#installation)
|
|
13
|
+
- [Examples](#examples)
|
|
13
14
|
- [Usage](#usage)
|
|
14
15
|
- [Configuration](#configuration)
|
|
15
16
|
- [Fira Code support](#fira-code-support)
|
|
@@ -42,6 +43,24 @@ You can also clone the repository with [Git](https://git-scm.com/)...
|
|
|
42
43
|
|
|
43
44
|
You can also run a development server, see the section on building later on.
|
|
44
45
|
|
|
46
|
+
## Examples
|
|
47
|
+
|
|
48
|
+
There is a small development server that can be run from within the project's directory with the following command:
|
|
49
|
+
|
|
50
|
+
npm start
|
|
51
|
+
|
|
52
|
+
The examples will then be available at the following URL:
|
|
53
|
+
|
|
54
|
+
http://localhost:8888
|
|
55
|
+
|
|
56
|
+
The source for the examples can be found in the `src/examples.js` file and corresponding `src/example` folder. You are encouraged to try the examples whilst reading what follows. You can rebuild them on the fly with the following command:
|
|
57
|
+
|
|
58
|
+
npm run watch-debug
|
|
59
|
+
|
|
60
|
+
The development server will reload the page whenever you make changes.
|
|
61
|
+
|
|
62
|
+
One last thing to bear in mind is that this package is included by way of a relative rather than a package import. If you are importing it into your own application, however, you should use the standard package import.
|
|
63
|
+
|
|
45
64
|
## Usage
|
|
46
65
|
|
|
47
66
|
There are three ways to use Yapp:
|