Skip to content

Commit

Permalink
Updating project read me.
Browse files Browse the repository at this point in the history
  • Loading branch information
addyosmani committed Jan 24, 2013
1 parent b0cd956 commit 57bfc05
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
#jQuery UI Bootstrap

##Summary
This project was started to bring the beauty and ease-of-use of Twitter Bootstrap to jQuery UI widgets ♥.

This is a project I started to bring the beauty of Twitter's Bootstrap to jQuery UI widgets.
##Why?

Twitter's Bootstrap was one of my favorite projects to come out of 2011, but having used it regularly it left me wanting two things:
Bootstrap is one of our favorite projects, but having used it regularly it left us wanting two things:

* The ability to work side-by-side with jQuery UI (something which caused a number of widgets to break visually)
* The ability to theme jQuery UI widgets using Bootstrap styles. Whilst I love jQuery UI, I (like others) find some of the current themes to look a little dated. My hope is that this theme provides a decent alternative for others that feel the same.
* The ability to theme jQuery UI widgets using Bootstrap styles. Whilst we love jQuery UI, we find some of the current themes to look a little dated. Our hope is that this theme provides a decent alternative for others that feel the same.

To clarify, this project doesn't aim or intend to replace Twitter Bootstrap. It merely provides a jQuery UI-compatible theme inspired by Bootstrap's design. It also provides a version of Bootstrap CSS with a few (minor) sections commented out which enable the theme to work along-side it.

I welcome any and all feedback as I'd very much like this theme to be as solid as possible.
We welcome any and all feedback as we would very much like this theme to be as solid as possible.

##Browser-support

Expand All @@ -21,24 +21,27 @@ There *are* some minor known issues lingering that I'm working on, but the hope

##jQuery UI support

This theme targets jQuery UI 1.9.2 and the default version of jQuery included in the (current) jQuery UI builds (jQuery 1.6.2).
I'm aware of jQuery 1.8.2 and intend on upgrading anything necessary in the theme to use it when the jQuery UI team officially include it in their theme packs.
This theme targets jQuery UI 1.9.2 and the default version of jQuery included in the (current) jQuery UI builds (jQuery 1.6.2+).

##Project status

This project is under active, but slow development. There has been a great deal
of work done in branches to introduce compatibility with jQuery UI 1.9 and further
work done to move us towards using LESS and improved parity with Bootstrap 2.x.

At this time, I am seeking contributors interested in helping us finally complete
At this time, we are seeking contributors interested in helping us finally complete
the work needed to be Bootstrap 2.x compatible. This would involve helping in your
spare time across a few weeks and you would be given credit in the project README.

As one of the (currently) more popular open-source jQuery UI themes I would love to
get out a new release sometime soon and your help with this would be greatly appreciated.
As one of the (currently) more popular open-source jQuery UI themes we would love to
get out more frequent releases and your help with this would be greatly appreciated.

##Team

* [Addy Osmani](https://github.com/addyosmani)
* [Gerits Aurelien](https://github.com/gtraxx)
* You? ; ) We're always open to improvements.

##Demo

For a live preview of the current theme, see [http://addyosmani.github.com/jquery-ui-bootstrap](http://addyosmani.github.com/jquery-ui-bootstrap).

A [blog post](http://addyosmani.com/blog/jquery-ui-bootstrap/) with some more details about the project is also available.

0 comments on commit 57bfc05

Please sign in to comment.