Skip to content

Commit

Permalink
Updated README for version 1.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
snej committed Nov 5, 2012
1 parent b14a2d1 commit e81b50c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ By "_CouchDB-compatible_" I mean that it can replicate with CouchDB, and that it

By "_suitable for embedding into mobile apps_", I mean that it meets the following requirements:

* Small code size; currently about 250kbytes. (Code size is important to mobile apps, which are often downloaded over cell networks.)
* Small code size; currently about 350kbytes of ARM7 code. (Code size is important to mobile apps, which are often downloaded over cell networks.)
* Quick startup time on relatively-slow CPUs; ideally 100ms or less.
* Low memory usage with typical mobile data-sets. The expectation is the number of documents will not be huge, although there may be sizable multimedia attachments.
* "Good enough" performance with these CPUs and data-sets.

And by "_mobile apps_" I'm focusing on iOS and [Android][11], although there's no reason we couldn't extend this to other platforms like Windows Phone. And it's not limited to mobile OSs -- the Objective-C implementation runs on Mac OS as well, and on Linux and other Unix-like OSs via [GNUstep][12].
And by "_mobile apps_" we're focusing on iOS and [Android][11], although there's no reason we couldn't extend this to other platforms like Windows Phone. And it's not limited to mobile OSs -- the Objective-C implementation runs on Mac OS as well, and on Linux and other Unix-like OSs via [GNUstep][12].

## More Information

Expand All @@ -34,7 +34,7 @@ And by "_mobile apps_" I'm focusing on iOS and [Android][11], although there's n
## Requirements ##

* It's written in Objective-C.
* Xcode 4.4+ is required to build it (Clang 3.1+, with GNUstep).
* Xcode 4.5+ is required to build it (Clang 3.1+, with GNUstep).
* Runtime system requirements for Apple platforms are iOS 5+, or Mac OS X 10.7.2+.

## License ##
Expand All @@ -47,9 +47,9 @@ And by "_mobile apps_" I'm focusing on iOS and [Android][11], although there's n

## Development Status ##

TouchDB went beta in June 2012. The current stable release is beta 3, [version 0.92][16].
TouchDB 1.0 was released on November 5, 2012.

We don't have a formal schedule for 1.0, but expect the blessed event by the end of summer.
In general, the "stable" branch represents the latest stable release, while the "master" branch has the latest commits and may not be stable.

## Downloading TouchDB ##

Expand Down

0 comments on commit e81b50c

Please sign in to comment.