Merge pull request #9 from VagabondAzulien/readme_edit

README update

README.md

@@ -5,6 +5,13 @@
 
 # Sapling: A Dialogue Tree CLI Utility
 
+[![Gem
+Version](https://badge.fury.io/rb/sapling-dialogue.svg)](
+https://badge.fury.io/rb/sapling-dialogue) [![Build
+Status](
+https://travis-ci.org/VagabondAzulien/sapling.svg?branch=master)](
+https://travis-ci.org/VagabondAzulien/sapling)
+
 Sapling allows for easy creation and use of dialogue trees.
 
 A dialogue tree is a series of dialogues which follow sequentially, though with
@@ -21,9 +28,9 @@ branch represents a choice taken in the dialogue. Branches flow to each other
 through leafs, which are the actual choices.
 
 You can experience this yourself, by loading "Example Quest! - A Meta Dialogue
-Tree!". You can find the tree itself at [trees/example\_quest.yaml](
+Tree!". You can find the tree itself at [var/trees/example\_quest.yaml](
-var/trees/example_quest.yaml). To run it, just type `sapling -t
+https://github.com/VagabondAzulien/sapling/blob/master/var/trees/example_quest.yaml).
-trees/example_quest.yaml`.
+To run it, just type `sapling read path/to/example_quest.yaml`.
 
 ## Building a New Tree
 
@@ -31,30 +38,35 @@ To build a new tree, you have two options. You can manually edit a configuration
 file, or go through the construction wizard. Either way, the end result is a
 plain-text configuration file, which can be easily shared, edited, and viewed.
 For more details on the configuration file itself, check out the [Configuration
-File documentation](var/docs/config_file.md), or the self-documented
+File documentation](
-[configuration file example](var/docs/config_file_example.yaml). Alternatively,
+http://www.theinternetvagabond.com/sapling/file.config_file.html), or the
-you can checkout [Example Quest](var/trees/example_quest.yaml) for a complete
+self-documented [configuration file example](
-tree.
+http://www.theinternetvagabond.com/sapling/file.config_file_example.html).
+Alternatively, you can checkout [Example Quest](
+https://github.com/VagabondAzulien/sapling/blob/master/var/trees/example_quest.yaml)
+for a complete tree.
 
 ### Manual Edit
 
 1. Open your preferred text editor.
-2. Refer to the [Configuration File documentation](var/docs/config_file.md)
+2. Refer to the [Configuration File documentation](
+http://www.theinternetvagabond.com/sapling/file.config_file.html)
 3. Make your changes.
 4. Save your changes.
 
 ### Automatic Edit -- Coming Soon(tm)!
 
-1. Run the configuration editor: `sapling --edit [--new][--file FILE]`
+1. Run the configuration editor: `sapling edit [TREE]`
-2. If you choose to create a new dialogue, `sapling` will generate a new file in
+2. If you don't include a TREE, `sapling` will create a new tree in the current
-   your current directory.
+   directory.
 3. If you choose to modify an existing file, `sapling` will open the tree at the
    trunk, and show you the first branch.
 4. Make your changes.
 5. Save your changes.
 
 More details on the editor can be found in the [Editor
-documentation](var/docs/editor.md).
+documentation](
+http://www.theinternetvagabond.com/sapling/file.editor.html).
 
 ## Contributing
 
@@ -62,10 +74,12 @@ You can contribute to Sapling by following these instructions:
 1. Fork this repository.
 2. In your fork, make your changes.
 3. Make sure your changes respect the [contribution
-   guidelines](CONTRIBUTING.md).
+   guidelines](
+   http://www.theinternetvagabond.com/sapling/file.CONTRIBUTING.html).
 4. Submit a pull request.
 
 ## License
 
 Sapling is licensed under the MIT license. The full text can be found in
-[LICENSE](LICENSE).
+[LICENSE](
+http://www.theinternetvagabond.com/sapling/file.LICENSE.html).