Skip to content

Commit 3b0acf0

Browse files
author
Juan Lulkin
authored
Revamp README
1 parent cb35c1f commit 3b0acf0

1 file changed

Lines changed: 5 additions & 11 deletions

File tree

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@
66

77
## HTML2Slim
88

9-
Script for converting HTML and ERB files to slim (slim-lang.org).
10-
11-
It's not perfect, but certainly it helps a lot!
12-
13-
It's based on Hpricot. Yeah, I'm old school.
9+
Script for converting HTML and ERB files to [slim](http://slim-lang.com/).
1410

1511
## Usage
1612

@@ -32,22 +28,20 @@ You may convert files using the included executables `html2slim` and `erb2slim`.
3228
-h, --help Show this message
3329
-v, --version Print version
3430

35-
Alternatively, to convert files or strings on the fly in your application, you may do so by calling `HTML2Slim.convert!(file, format)` where format is either :html or :erb.
31+
Alternatively, to convert files or strings on the fly in your application, you may do so by calling `HTML2Slim.convert!(file, format)` where format is either `:html` or `:erb`.
3632

3733
## License
3834

3935
This project is released under the MIT license.
4036

4137
## Author
4238

43-
[Maiz Lulkin] (https://github.com/joaomilho) and [contributors](https://github.com/slim-template/html2slim/graphs/contributors)
39+
[Maiz Lulkin](https://github.com/joaomilho) and [contributors](https://github.com/slim-template/html2slim/graphs/contributors)
4440

4541
## OFFICIAL REPO
4642

4743
[https://github.com/slim-template/html2slim](https://github.com/slim-template/html2slim)
4844

49-
## ROADMAP
45+
## GOOD TO KNOW
5046

51-
1. ERB support is beta, and works only for ~92.6% of the cases. Lotsa weird regexes. Gotta improve that.
52-
2. Use temple.
53-
3. Merge with other *2slim gems. Would be handy.
47+
ERB requires a full Ruby parser, so it doesn't really work for all use cases, but it's certainly helpful.

0 commit comments

Comments
 (0)