Skip to content

Commit d26ee58

Browse files
authored
#4 add README notes on updating + fix typo
1 parent 63b5264 commit d26ee58

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Execute the contents of [**libreveal.min.js**](https://github.com/gingeleski/lib
1111

1212
See the unminified [**libreveal.js**](https://github.com/gingeleski/libreveal.js/blob/master/libreveal.js) script if you're curious how this works and/or what checks are run.
1313

14-
## Support libraries
14+
## Supported libraries
1515

1616
Currently this will detect...
1717

@@ -39,6 +39,14 @@ Currently this will detect...
3939
- ExtJS
4040
- Bootstrap
4141

42+
## Updating
43+
44+
Run the Python script `compile.py` that's in `src/` to sync this with RetireJS.
45+
46+
Integrate your own edits via the libreveal file in `src/json/`.
47+
48+
There are no dependencies - just `cd` into `src/` and run `python compile.py` (note Python 3.x is needed though).
49+
4250
## Credit
4351

4452
Derived in part from [**retire.js**](https://github.com/retirejs/retire.js/) identifiers - this stands on the shoulders of that project.

0 commit comments

Comments
 (0)