Updates for 0.0.4

1 files changed, 67 insertions, 15 deletions

diff --git a/README b/README
index 7f6886a47..19c8d3118 100644
--- a/README
+++ b/README
@@ -1,32 +1,75 @@
 INTRODUCTION
 
-Tracker is a powerful metadata database and indexer framework that provides the ability to index, store, retrieve and search all types of file metadata including user defined ones. Tracker is super efficient with your systems memory when compared with some other competing frameworks, which offer less functionality too.
+Tracker is a powerful desktop-neutral first class object database framework and indexer. 
 
+Tracker is also extremely fast and super efficient with your systems memory when compared with some other competing frameworks and is by far the fastest and most memory efficient Nautilus search and Deskbar backends currently availble.
 
-NEW FEATURES
+It consists of a common object database that allows entities to have an almost infinte number of properties, metadata (both embedded/harvested as well as user definable), a comprehensive database of keywords/tags and links to other entities.
 
-* Redesigned DBus Api to be more generic
+It provides additional features for file based objects including context linking and audit trails for a file object.
 
-* Corrected search results of hyphenated search terms
+It has the ability to index, store, harvest metadata. retrieve and search all types of files and other first class objects.
 
-* Added support for limiting no. of hits for searches
+First class object support includes : Files, Documents, Music, Images, Videos, Playlists*, Notes*, Applications*, Contacts*, Emails*, Conversations*, Appointments*, Tasks*, Bookmarks*, History* and Projects*
 
-* Added optional support for sorting search results by relevance score
+(* these services are not currently indexed at the moment but will be in later versions)
 
-* A few minor bug fixes (Updating file name metadata correctly during move, correcting use of hyphenated search terms)
 
+USE CASES
 
-Tracker's features include:
+Tracker is the most powerful open source metadata database and indexer framework currently available and because it is built around a combination indexer and sql database and not a dedicated indexer it has much more powerful use cases:
+
+* Provide search and indexing facilities similiar to those on other systems
+
+* Common database storage for all first class objects (EG a common music/photo/contacts/email database) complete with additional metadata and tags/keywords
+
+* Comprehensive one stop solution for all applications needing an object database, powerful search (via RDF Query), first class methods, related metadata and user definable metadata/tags
+
+* Can provide a full semantic desktop with metadata everywhere
+
+* Can provide powerful criteria based searching suitable for creating smart file dialogs and vfolder systems
+
+* Can provide a more intelligent desktop using statistical metadata
+
+
+
+NEW CHANGES
+
+* Redesigned Database around version 5 of the *embedded* in-process mysql database library
+
+* Now uses the auto repair facility provided by mysql to automatically repair damaged database files so you need never worry about losing your precious data.
+
+* Moved virtually all DB logic into stored procedures which provides a clean seperation of DB logic and application logic
+
+* Added support for parsing dates in various formats including conversion to/from ISO 8601 format
+
+* Fixed MsWord filter to prevent looping (WvText causes inotify to report file write change causing endless looping)
+
+* Redesigned DB structure to be more generic and service orientated
+
+* Added support for service types (first class objects) to DB
+
+* Cleaned up code warnings and fixed potential crasher (thanks to patch from Nate Nielsen)
+
+* Fixed issues with argv handling (thanks to patch from  Dan Nicolaescu)
+
+* Fixed build issue for Fedora Core 5 (thanks to patch from  Dan Nicolaescu)
+
+
+
+FEATURES
+
+* Desktop-neutral design (its a freedesktop product built around other freedesktop technologies like DBus and XDGMime but contains no GNOME specific dependencies)
 
 * Very memory efficient and non-leaking (typical RAM usage 4 - 6 MB). Unlike some other indexers, tracker is designed and built to run well on lower memory systems with typically 128MB or 256MB memory. It should even be efficient enough to use on some mobile devices.
 
 * Non-bloated and written in C for maximum efficiency.
 
-* Fast indexing and unobtrusive - no need to index stuff overnight. Tracker runs at nice+10 so it should have a minimal impact on your system. 
+* Small size and minimal dependencies makes it easy to bundle into various distro's including live cds.
 
-* Integrated as a Nautilus search backend and as a Deskbar applet backend.
+* Fast indexing and unobtrusive - no need to index stuff overnight. Tracker runs at nice+10 so it should have a minimal impact on your system. 
 
-* Implements the freedesktop specification for metadata http://freedesktop.org/wiki/Standards_2fshared_2dfilemetadata_2dspec
+* Implements the freedesktop specification for metadata http://freedesktop.org/wiki/Standards/shared-filemetadata-spec
 
 * Extracts embedded File, Image, Document and Audio type metadata from files.
 
@@ -50,9 +93,17 @@ Tracker's features include:
 
 INSTALLATION (from source):
 
-You will need to make sure you have the following dependencies installed : 
 
-libmysqld.a (version 4.1 or higher but not version 5) - this is the embedded mysql server library. This can be found in Debian/Ubuntu package libmysqlclient14-dev. RPMs (look for embedded server) can be found at : http://dev.mysql.com/downloads/mysql/4.1.html (NB tracker does not work with the client/server versions of mysql so you must have the correct *embedded server* package installed). You do not have to setup anything as the embedded library is ued in-process and therefore needs no user accounts or authentication and will work straight out of the box.
+The following build dependency is needed:
+
+libmysqld.a version 5.0.19 or higher is required -  this is the embedded mysql server library. This library is always statically linked so it is not a runtime dependency. It can be found in Debian/Ubuntu package libmysqlclient15-dev. Other distros should check their mysql client libs to see if it is present.
+
+If not present you can compile libmysqld.a by downloading source tarball for an appropriate version (5.0.19+) from the bottom of page http://dev.mysql.com/downloads/mysql/5.0.html
+
+The following configure flags are reccommended if building mysqld.a from source: --without-server --with-embedded-server --enable-assembler --with-mysqld-ldflags --with-client-ldflags 
+
+
+Run time dependencies (also needed for build) :
 
 libdbus (0.50 +)
 
@@ -64,7 +115,8 @@ zlib
 
 libvorbisfile3 (1.1+) 
 
-Recommended packages:
+
+Additional recommended packages:
 
 libextractor (0.5.9+) (tracker has a streamlined version inlined)
 wv (1.0.2+)
@@ -127,7 +179,7 @@ To make sure trackerd always start when you login to Gnome, you will need to add
 
 Tracker and Deskbar applet
 
-Tracker is also integrated in gnome's deskbar applet. Please see that applet for more info.
+Tracker is also integrated in GNOME's deskbar applet. Please see that applet for more info.