Skip to content

Commit

Permalink
Updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
synhershko committed Apr 8, 2012
1 parent 56aef6e commit f37b6ae
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions readme.txt
@@ -1,7 +1,19 @@
Raven DB
========
# Raven DB

This release contains the following:
## A 2nd generation document database

Issue tracker: http://issues.hibernatingrhinos.com

You can start the Raven Service by executing /server/raven.server.exe, and then you can then visit
http://localhost:8080 for looking at the UI.

For any questions, please visit: http://groups.google.com/group/ravendb/

RavenDB's homepage: http://ravendb.net

For your convenience RavenDB is also available as nuget packages: RavenDB.Client and RavenDB.Embedded.

## This release contains the following:

/Client - RavenDB lightweight client for .NET 4.0 and its dependencies.
*** This is the recommended client to use ***
Expand All @@ -17,6 +29,9 @@ This release contains the following:
Reference Raven.Client.Embedded.dll and create a DocumentStore, passing a URL
or a directory. See the docs for more help.

Whichever client version you choose to use, reference all the assemblies in the corresponding folder to your project.

As for the rest of the folders in the package, here's a brief description of what they contain:

/Server - The files required to run RavenDB in server / service mode.
Execute /Server/Raven.Server.exe /install to register and start the Raven service
Expand All @@ -29,16 +44,7 @@ This release contains the following:
/Samples - Some sample applications for RavenDB
* Under each sample application folder there is a "Start Raven.cmd" file which will
starts Raven with all the data and indexes required to run the sample successfully.

RavenSmuggler - The Import/Export utility for RavenDB



You can start the Raven Service by executing /server/raven.server.exe, and then you can then visit
http://localhost:8080 for looking at the UI.

For any questions, please visit: http://groups.google.com/group/ravendb/

Raven's homepage: http://ravendb.net
/Backup - [Standalone backup tool](http://ravendb.net/docs/server/administration/backup-restore), for performing backup operations using a user with admin privileges.

For your convenience RavenDB is also available as nuget packages: RavenDB and RavenDB-Embedded.
/Smuggler - [The Import/Export utility](http://ravendb.net/docs/server/administration/export-import) for RavenDB.

0 comments on commit f37b6ae

Please sign in to comment.