update CHANGELOG and README

nedkelly · Dec 20, 2018 · 211b44f · 211b44f
1 parent 60f7b55
commit 211b44f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,4 +1,8 @@
 
+1.0.0
+
+ * First working release, includes `markdown` filter and `markdown` tag
+
 0.0.0
 
  * Initial release, Marked not yet hooked up
diff --git a/README.md b/README.md
@@ -1,18 +1,20 @@
 # Twing Markdown
 [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage percentage][coveralls-image]][coveralls-url]
 
-## WORK IN PROGRESS
-
-**This package is not yet production ready!**
-
----
-
 Implements [Marked](https://www.npmjs.com/package/marked) for [Twing](https://www.npmjs.com/package/twing) using twig `{% markdown %} {% endmarkdown %}` tags.
 
+_**NB:** Not yet implemented in browser!_
+
 ## Example
 
 Twig:
 ```twig
+{# With Filter #}
+
+{{ '# Some markdown here...'|markdown }}
+
+{# With Tag #}
+
 {% markdown %}
   # Some markdown here...
 {% endmarkdown %}
@@ -26,7 +28,7 @@ HTML:
 ## Usage
 
 ```javascript
-import { TwingLoader, TwingLoaderFilesystem } from "twing";
+import { TwingLoaderFilesystem, TwingEnvironment } from "twing";
 import { TwingExtensionMarkdown } from "twing-markdown";
 
 const loader = new TwingLoaderFilesystem('/path/to/templates');