Skip to content

Commit f779b0e

Browse files
committed
Update docs
1 parent e9ec220 commit f779b0e

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ implementation which provides the following classes:
88
* __Model class__: subclass this for your JSON models, and separately define the members of your class;
99
* __View classes__: classes are provided for form, list, button, etc.
1010

11-
## Clone
11+
It uses [Bootstrap](https://getbootstrap.com/) to implement the underlying user
12+
interface, adding a few components.
13+
14+
## Clone, Build, Release
1215

1316
You'll need to use `npm` to install as a dependency in your module. Here is what
1417
I do on my Mac which has homebrew installed:
@@ -19,11 +22,28 @@ I do on my Mac which has homebrew installed:
1922
[bash] git clone git@github.com:djthorpe/js-framework.git
2023
[bash] cd js-framework
2124
[bash] npm install
25+
[bash] npm build
26+
```
27+
28+
This will place the files in the `dist` folder. There is a github action which
29+
runs on a new release to publish the package.
30+
31+
## Use
32+
33+
Use the framework as follows:
34+
35+
```bash
36+
[bash] brew install npm
37+
[bash] cd $PROJECTS
38+
[bash] git clone git@github.com:@owner/js-project.git
39+
[bash] cd js-project
40+
[bash] echo "@djthorpe:registry=https://npm.pkg.github.com" >> .npmrc
41+
[bash] npm install @djthorpe/js-framework
2242
```
2343

24-
## Test
44+
## Class Reference
2545

26-
## Provider
46+
### Provider
2747

2848
The provider is used to fetch JSON objects and arrays from a remote REST source, and stores them. To construct a provider with a model class called MyModelClass,
2949

0 commit comments

Comments
 (0)