Update 'README.md'
This commit is contained in:
parent
f407ad8b46
commit
d13f5cd27b
|
@ -1,6 +1,6 @@
|
||||||
# Ficdown.js
|
# Ficdown.js
|
||||||
|
|
||||||
Ficdown is a system for building interactive fiction using MarkDown syntax, and Ficdown.js is a Javascript library for presenting Ficdown stories interactively in a web browser. See [Ficdown.com](http://www.ficdown.com/) for more information.
|
Ficdown is a system for building interactive fiction using MarkDown syntax, and Ficdown.js is a Javascript library for presenting Ficdown stories interactively in a web browser.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
|
@ -25,7 +25,7 @@ You can combine all three `build`, `pack`, and `minify` steps with this command:
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
You can obtain *ficdown.js* or *ficdown.min.js* from the latest version on the [releases](https://github.com/rudism/Ficdown.js/releases) page. See the example [test.html](https://github.com/rudism/Ficdown.js/blob/master/test.html) file for basic usage and styling. The example includes the story content in a hidden text area so it can run locally in a browser.
|
You can obtain *ficdown.js* or *ficdown.min.js* from the latest version on the [releases](https://code.sitosis.com/rudism/ficdown.js/releases) page. See the example [test.html](https://github.com/rudism/Ficdown.js/blob/master/test.html) file for basic usage and styling. The example includes the story content in a hidden text area so it can run locally in a browser.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
var player = new Ficdown(playerOptions);
|
var player = new Ficdown(playerOptions);
|
||||||
|
|
Loading…
Reference in New Issue