Skip to content

Commit 70884b9

Browse files
committed
README update
1 parent 25a7ebb commit 70884b9

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# HAML.jl
22

3-
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://tkluck.github.io/HAML.jl/dev/)
3+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://tkluck.github.io/HAML.jl/stable/)
44

55
HTML Abstract Markup Language for Julia. Inspired by [Ruby's HAML](http://haml.info/).
66

@@ -52,14 +52,9 @@ This distinguishes them from file-local variables.
5252

5353
## Syntax
5454

55-
We don't have a syntax reference for `HAML.jl` yet. It mostly follows
56-
[Ruby's syntax document](http://haml.info/docs/yardoc/file.REFERENCE.html) with
57-
the following exceptions:
58-
59-
- use named tuple syntax for attributes
60-
- use `- @include` for including `.hamljl` files.
61-
62-
See the [test cases](test/runtests.jl) for examples.
55+
If you are already familiar with Ruby-flavoured HAML, [read about the
56+
differences here][fromruby]. If not, either use read the [getting started guide][gettingstarted]
57+
or the [syntax reference][syntax].
6358

6459
[travis-img]: https://travis-ci.org/tkluck/HAML.jl.svg?branch=master
6560
[travis-url]: https://travis-ci.org/tkluck/HAML.jl
@@ -69,3 +64,7 @@ the following exceptions:
6964

7065
[codecov-img]: https://codecov.io/gh/tkluck/HAML.jl/branch/master/graph/badge.svg
7166
[codecov-url]: https://codecov.io/gh/tkluck/HAML.jl
67+
68+
[fromruby]: https://tkluck.github.io/HAML.jl/stable/fromruby/
69+
[gettingstarted]: https://tkluck.github.io/HAML.jl/stable/getting-started/
70+
[syntax]: https://tkluck.github.io/HAML.jl/stable/syntax/

0 commit comments

Comments
 (0)