From 6fff05a097d44f203c60c7c46b22f16a74d8408c Mon Sep 17 00:00:00 2001 From: Ville Talonpoika Date: Thu, 5 May 2016 23:08:00 +0300 Subject: [PATCH] Updated documentation to reflect the changes in 0.7.0 --- DOCUMENTATION.md | 65 +++++++++++++++++------------------------------- README.md | 11 ++++---- 2 files changed, 28 insertions(+), 48 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index f6eacde..beadf17 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -42,67 +42,48 @@ ## HTML structure -Novel.js needs some HTML on the webpage to run properly. You can use this code or some variant of it: +Novel.js needs some HTML on the webpage to run properly. You can use the simple `````` tag or if you need more control you can use this code or some variant of it: ```html
-
-
-
+
+
+

Copy and save this text:

-

+

-
+

Paste your save data here:

-

+

-
-
- {{{ printedText }}} -
- - -
- -
+
+
+ +
-
+
+
    +
    +
    Inventory:
    -
      -
    • - {{{ item.displayName }}} - {{{ item.value }}} -
    • -
    +
      -
      +
      Stats:
      -
        -
      • - {{{ item.displayName }}} - {{{ item.value }}} -
      • -
      +
        -
        - - +
        + +
        ``` +Only one Novel.js instance per webpage is supported. + ## `novel.json` structure `novel.json` is a JavaScript Object Notation file - a neat way to work with structured information. The top level of the structure contains the following attributes: diff --git a/README.md b/README.md index 4fb2840..432789a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ It is suitable for interactive fiction such as "choose your own adventure" games Text adventures are often overlooked as something only game development beginners create, and Novel.js aims to fix this misconception. Interactive fiction combines the flexibility and possibilities that prose can offer with interactivity and reader choice – a type of entertainment I think has not yet been thoroughly explored. The popularity of visual novels demonstrates the possibilities the medium can offer! -Novel.js is written in CoffeeScript, HTML and SASS and depends only on Vue.js. It was born out of a need for a lightweight, easy-to-use but fully-featured text adventure system that could easily be embedded on a webpage. It is open source (MIT License) and free to use both commercially and non-commercially. A **[live demo](http://nanofus.github.io/novel.js/)** is available, however it covers only a small part of all functionality! +Novel.js is written in CoffeeScript, HTML and SASS and has no dependencies. It was born out of a need for a lightweight, easy-to-use but fully-featured text adventure system that could easily be embedded on a webpage. It is open source (MIT License) and free to use both commercially and non-commercially. A **[live demo](http://nanofus.github.io/novel.js/)** is available, however it covers only a small part of all functionality! You can use [electron-noveljs-boilerplate](https://github.com/Nanofus/electron-noveljs-boilerplate) with Novel.js to create standalone desktop applications. It requires a bit more technical knowledge than Novel.js itself. @@ -60,15 +60,14 @@ These features are planned or currently in development. ### Non-techy installation 1. Download the [latest release .zip](https://github.com/Nanofus/novel.js/releases/latest) and extract it. -2. Uncomment the commented `