diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..aaa0c8c --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2020-present Jared White + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +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. diff --git a/README.md b/README.md index df89bc0..2fe4aa7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,24 @@ # 👑 Serbea: Similar to ERB, Except Awesomer -Public beta release coming soon! +[![Gem Version](https://badge.fury.io/rb/serbea.svg)](https://badge.fury.io/rb/serbea) -[www.serbea.dev](https://www.serbea.dev) \ No newline at end of file +**Serbea is the Ruby template engine you didn’t realize you needed. Until now.** + +Serbea combines the best ideas from “brace-style” template languages such as Liquid, Nunjucks, Twig, Jinja, Mustache, etc.—and applies them to the world of ERB. You can use Serbea in Rails applications, Bridgetown static sites, or pretty much any Ruby scenario you could imagine. + +**Documentation and examples are on our website:** + +[www.serbea.dev](https://www.serbea.dev) + + +## Contributing + +1. Fork it (https://github.com/bridgetownrb/serbea/fork) +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request + +## License + +MIT \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index 6632449..8862314 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -43,7 +43,7 @@ layout: home {%@remove "timeline-read-more" %} {%@append "timeline" do %} {%@ partial: "posts", formats: [:html] %} - {%@ %} + {% end %} ``` * Built-in frontmatter support. Now you can access the variables written into a top YAML block within your templates. In any Rails view, including layouts, you'll have access to the `@frontmatter` ivar which is a merged `HashWithDotAccess::Hash` with data from any part of the view tree (partials, pages, layout).