Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

Commit

Permalink
Write the 0.9.3 docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jverkoey committed Jun 11, 2012
1 parent be1caea commit 3d4fd27
Show file tree
Hide file tree
Showing 2 changed files with 217 additions and 144 deletions.
38 changes: 4 additions & 34 deletions README.mdown
Original file line number Diff line number Diff line change
@@ -1,41 +1,11 @@
Nimbus is an iOS framework whose feature set grows only as fast as its documentation.

By focusing on documentation first and features second, Nimbus hopes to be a framework
that accelerates the development process of any application by being easy to use and simple
to understand.

<h2>Getting Started</h2>

- Visit the Nimbus website at <a href="http://nimbuskit.info">nimbuskit.info</a>.
- <a href="http://wiki.nimbuskit.info/Nimbus-Overview">Learn when and why you should use Nimbus</a>.
- <a href="http://wiki.nimbuskit.info/Add-Nimbus-to-your-project">Add Nimbus to your project</a>.
- Follow Nimbus' development through its <a href="http://jverkoey.github.com/nimbus/group___version-_history.html">version history</a>.
- See the <a href="http://jverkoey.github.com/nimbus/group___version-9-2.html">latest API diffs</a>.
- Read the <a href="http://jverkoey.github.com/nimbus/group___three20-_migration-_guide.html">Three20 Migration Guide</a>.
- Follow Nimbus' development through its <a href="http://docs.nimbuskit.info/group___version-_history.html">version history</a>.
- See the <a href="http://docs.nimbuskit.info/group___version-9-2.html">latest API diffs</a>.
- Read the <a href="http://docs.nimbuskit.info/group___three20-_migration-_guide.html">Three20 Migration Guide</a>.
- Ask questions and get updates via the <a href="http://groups.google.com/group/nimbusios">Nimbus mailing list</a>.

<h2>Nimbus' Background</h2>

Nimbus has been built with much inspiration from the Three20 framework. That being said, there
are a number of fundamental problems with Three20 that Nimbus works very hard to avoid.
Among them:

- Poor documentation.
- Spaghetti dependencies.
- Suffering from a "kitchen sink" complex.
- A complex build structure.
- An enormous number of difficult-to-solve bugs.
- Next-to-zero test coverage.

For its weaknesses, Three20 does provide a good deal of value through its feature set. It is
used in over 100 apps in the app store by companies such as Facebook, LinkedIn, Posterous,
Meetup, and SCVNGR.

Nimbus hopes to one day provide as much value as Three20 does on a feature-by-feature
comparison, but with the invaluable benefit of sublime documentation and test coverage.

<h2>Nimbus' Development Roadmap</h2>

Most of the discussion revolving around Nimbus' roadmap is in the Github issue tracker. In
particular, check out the grab bag of tasks that are actively being worked on here:

https://github.com/jverkoey/nimbus/issues?milestone=5&sort=created&direction=desc&state=open
Loading

0 comments on commit 3d4fd27

Please sign in to comment.