From 15a0596fffd12996a7011539ddcc270619ecf9d1 Mon Sep 17 00:00:00 2001 From: Jack Lukic Date: Sun, 13 Oct 2013 16:35:07 -0400 Subject: [PATCH] Update README.md Updates readme to include build test status, adds more formatting --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1854eb1f5..1d6df1420 100755 --- a/README.md +++ b/README.md @@ -1,14 +1,24 @@ # Semantic +[![Build Status](https://travis-ci.org/jlukic/Semantic-UI.png)](https://travis-ci.org/jlukic/Semantic-UI) Semantic is a set of specifications for sharing UI elements between developers. Semantic is also a UI library to make front end development simpler and easier to learn. ## Development Status -Semantic is pre-release. Build tools are not yet available, and APIs may be updated regularly prior to 1.0, so be warned! +Semantic is production ready, but is formally "pre-release" until proper build and theming tools are available, and documentation is complete for all components. + +### Bugs and Issues Please [share any issues](https://github.com/jlukic/Semantic-UI/issues?state=open) you may have, we need your help to get all the kinks out. -If you need to create a test case, you can [fork this jsfiddle](http://jsfiddle.net/jlukic/Vbr9d/1/) to get you started. +If you are reporting a bug *you must create a test-case*. You can [fork this jsfiddle](http://jsfiddle.net/jlukic/Vbr9d/1/) to get you started. + +### Roadmap +* [Features Missing for 1.0](https://github.com/jlukic/Semantic-UI/issues?direction=desc&milestone=1&page=1&sort=updated&state=open) +* [Planned Updates for 1.X](https://github.com/jlukic/Semantic-UI/issues?direction=desc&milestone=2&page=1&sort=updated&state=open) +* [Additional Components Scoped for 2.0](https://github.com/jlukic/Semantic-UI/issues?direction=desc&labels=&milestone=3&page=1&sort=updated&state=open) + +### Updates If you want to keep track of development, please [join our google group](https://groups.google.com/forum/?hl=en#!forum/semantic-ui) @@ -30,6 +40,10 @@ If you prefer to download the whole kit as a zip, it is so conveniently packaged http://semantic-ui.com/build/semantic.zip +### Right-to-Left (RTL Version) + +RTL versions are compiled on every patch update, and are available in ``/rtl/`` + ### LESS Semantic UI More css-processing features are currently being added to help in the customizing and theming Semantic UI. This will be one of the core features additions for Semantic's first release version.