Merge branch 'master' of https://github.com/radiatoryang/merino

LICENSE

@@ -19,3 +19,6 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+also contains the following third-party open source software, the use of which is hereby acknowledged:
+Yarn Spinner, copyright (c) 2015-2018 Secret Lab Pty. Ltd. and Yarn Spinner contributors. (https://github.com/thesecretlab/YarnSpinner)

README.md

@@ -1,34 +1,41 @@
 # merino
-Merino lets you write Yarn scripts inside the Unity Editor... (currently isn't ready at all / is totally broken and doesn't work)
+<img width=50% align=right src=https://raw.githubusercontent.com/radiatoryang/merino/master/merino_example.png> 
 
-### roadmap
+Merino is a narrative design tool that lets you write Yarn scripts inside the Unity Editor, built on top of [Yarn Spinner](https://github.com/thesecretlab/YarnSpinner) and [Yarn](https://github.com/InfiniteAmmoInc/Yarn).
 
-version 0.1
-- sidebar: list of nodes (click to select, rename, etc)
-- node edit window
-- can read/write to yarn.txt
+## download / install
+download and install from the [Releases page](https://github.com/radiatoryang/merino/releases);
+- "complete" .unitypackage includes Yarn Spinner
+- "minimal" .unitypackage is just Merino folder
 
-version 0.2
-- preview from node
+## usage / help / how-to / documentation
+read the [wiki documentation](https://github.com/radiatoryang/merino/wiki) for info on writing with Yarn / troubleshooting and tech support
 
-version 0.3
-- syntax highlighting: variables, comments, functions, shortcut choices
+### roadmap
+v0.4
+- refactor code and cleanup
+- user preferences: let user customize syntax highlighting colors, fonts / font sizes
 
-version 0.4
-- auto-complete
-- detect characters, functions, nodes, variables
+v0.5
+- auto-complete typing
+- detect characters, functions, nodes, variables for auto-complete
+- inline syntax highlighting for variable names somehow
 
-version 0.5
+v0.6
 - node map visualization
 
-version 0.6
-- generate nodes (prefix, count, one-way or not, connectivity chance, min / max exits, max dead ends)
-- untangle nodes
+v0.7
+- node analysis (reachability, random traversal)
+- node generator (prefix, count, one-way or not, connectivity chance, min / max exits, max dead ends)
+- untangle nodes / node organizer
 
-### uses
+### uses other peoples code
 - Unity Editor Coroutines https://github.com/marijnz/unity-editor-coroutines
 - Yarn Spinner https://github.com/thesecretlab/YarnSpinner
 - Yarn https://github.com/InfiniteAmmoInc/Yarn
 
+### see also
+- Ropework, a visual novel template for Unity / Yarn Spinner https://github.com/radiatoryang/ropework
+
 ### license?
 MIT