diff --git a/README.md b/README.md index 26035bcd..2b666c8f 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,27 @@ -# angel_hbs -Handlebars view generator for Angel. +# mustache +Mustache (Handlebars) view generator for Angel. # Installation In `pubspec.yaml`: - dependencies: - angel_mustache: ">= 1.0.0-dev < 2.0.0" +```yaml +dependencies: + angel_mustache: ^1.0.0 +``` + +If your project imports [`package:angel_common`](https://github.com/angel-dart/common), +then this is already installed. # Usage ``` -app.configure(mustache(new Directory('views'))); -``` +// Run the plug-in +await app.configure(mustache(new Directory('views'))); -``` +// Render `hello.mustache` res.render('hello', {'name': 'world'}); ``` # Options - **partialsPath**: A path within the viewsDirectory to search for partials in. Default is `./partials`. *Include the leading dot, please*. -- **fileExtension**: The file extension to search for. Default is `.mustache`. \ No newline at end of file +- **fileExtension**: The file extension to search for. Default is `.mustache`.