Skip to content

Commit

Permalink
#4 add README notes on updating + fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
gingeleski authored Dec 19, 2018
1 parent 63b5264 commit d26ee58
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Execute the contents of [**libreveal.min.js**](https://github.com/gingeleski/lib

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.

## Support libraries
## Supported libraries

Currently this will detect...

Expand Down Expand Up @@ -39,6 +39,14 @@ Currently this will detect...
- ExtJS
- Bootstrap

## Updating

Run the Python script `compile.py` that's in `src/` to sync this with RetireJS.

Integrate your own edits via the libreveal file in `src/json/`.

There are no dependencies - just `cd` into `src/` and run `python compile.py` (note Python 3.x is needed though).

## Credit

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

0 comments on commit d26ee58

Please sign in to comment.