@antimatter-audio/antimatter-ui 1.1.2 → 1.1.3
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 +9 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,7 +9,9 @@ A small library of UI components for Animatter Audio.
|
|
|
9
9
|
## Getting started
|
|
10
10
|
|
|
11
11
|
1. Clone this repo: `git clone git@github.com:antimatter-audio/antimatter-ui.git`.
|
|
12
|
+
|
|
12
13
|
2. Open this project in VS Code, and hit command-j to bring up the terminal.
|
|
14
|
+
|
|
13
15
|
3. Run `npm install`.
|
|
14
16
|
|
|
15
17
|
## Development
|
|
@@ -23,17 +25,23 @@ To view the most recent _published_ version of antimatter-ui:
|
|
|
23
25
|
1. Clone the [antimatter-plugin-template](http://github.com/antimatter-audio/antimatter-plugin-template) repo: `git clone git@github.com:antimatter-audio/antimatter-plugin-template.git`
|
|
24
26
|
|
|
25
27
|
2. Go to the **antimatter-plugin-template** folder, and open the `js` folder in VS Code. Hit command-j to bring up the terminal.
|
|
28
|
+
|
|
26
29
|
3. Run `npm install`.
|
|
30
|
+
|
|
27
31
|
4. Run `npm run start` to start your development server.
|
|
32
|
+
|
|
28
33
|
5. Go go [http://localhost:3000](http://localhost:3000) in your browser.
|
|
29
34
|
|
|
30
35
|
The default **antimatter-plugin-template** layout should now be viewable. This layout is a demo of all of the **antimatter-ui** components, and includes the latest _published_ version of this library.
|
|
31
36
|
|
|
32
37
|
NOTE: You will not see any _local_ changes you have made to this library yet. To preview your changes locally before publishing, you will need to [npm link](https://medium.com/dailyjs/how-to-use-npm-link-7375b6219557) this project with the **antimatter-plugin-template** front end application.
|
|
33
38
|
|
|
34
|
-
1. In **this project**, run: `npm run link-template
|
|
39
|
+
1. In **this project**, run: `npm run link-template`.
|
|
40
|
+
|
|
35
41
|
2. In the `js` folder in **antimatter-plugin-template**, run: `npm run link-ui`.
|
|
42
|
+
|
|
36
43
|
3. If your local development server is running in **antimatter-plugin-template**, hit option-c to shut it down.
|
|
44
|
+
|
|
37
45
|
4. Run `npm run start` in **antimatter-plugin-template** to start (or restart) your development server.
|
|
38
46
|
|
|
39
47
|
You should now see your local changes to these components at [http://localhost:3000](http://localhost:3000).
|