Neo4j 1.3
=======================================

Welcome to Neo4j release 1.3, a high-performance graph database.
This is the standard distribution of Neo4j, including everything you need to
start building applications that can model, persist and explore graph-like data.

In the box
----------

Neo4j runs as a server application, exposing a Web-based management
interface and RESTful endpoints for data access, along with logging and JMX.

Here in the installation directory, you'll find:

* bin - scripts and other executables
* conf - server configuration
* data - database, log, and other variable files
* doc - more light reading
* examples - real code
* lib - core libraries
* plugins - user extensions
* system - super-secret server stuff

Make it go
----------

To get started with Neo4j, let's start the server and take a
look at the web interface...

1. open a console and navigate to the install directory
2. start the server
   * Windows: use `bin\Neo4j.bat`
   * Linux/Mac: use `bin/neo4j start`
3. in a browser, open [webadmin](http://localhost:7474/webadmin/)
4. from any REST client or browser, open (http://localhost:7474/db/data) 
   in order to get a REST starting point, e.g.
   `curl -v http://localhost:7474/db/data`
5. shutdown the server
   * Windows: type Ctrl-C to terminate the batch script
   * Linux/Mac: use `bin/neo4j stop`

Learn more
----------

There is a humble user guide available in the `doc` directory, a collection of 
short operational and informational articles. 

Out on the internets, you'll find:

* [Neo4j Home](http://neo4j.org)
* [Getting Started](http://wiki.neo4j.org/content/Getting_Started)
* [Neo4j Community Wiki](http://wiki.neo4j.org)
* [Neo4j Components](http://components.neo4j.org)

For more links, a handy [guide post](doc/guide-post.html) in the `doc` 
directory will point you in the right direction.

Examples
--------

The `examples` directory has working code for programming with Neo4j and
interacting with the server through REST.

The command line `curl` tool is useful for "programming" against the REST
api outside of a particular language. The REST examples take that approach.

For JVM-based "embedded programming" with Neo4j, you'll find examples 
written in Java.

License(s)
----------
Various licenses apply. Please refer to the LICENSE and NOTICE files for more
detailed information. A full report regarding the licenses of all included
dependencies is found in site/dependencies.html.




