THIS IS AN EXAMPLE README FILE FOR NEO4J DRIVER AUTHORS TO USE AS A TEMPLATE.
Neo4j is a transactional, open-source graph database. A graph database manages data in a connected data structure, capable of representing any kind of data in a very accessible way. Information is stored in nodes and relationships connecting them, both of which can have arbitrary properties. To learn more visit What is a Graph Database?
<Look at http://shields.io/ or https://ghbtns.com/ for potential badges for quick-glance information>
A brief description of your project
<Simple installation instructions>
<A short code snippet showing how you can get connected to Neo4j with your driver>
<A short code snippet showing what you can do with Neo4j with your driver>
Version | Tested |
---|---|
1.9 | <Yes/No> |
2.0 | <Yes/No> |
2.1 | <Yes/No> |
2.2 | <Yes/No> |
Feature | Supported? |
---|---|
Auth | <Yes/No> |
Remote Cypher | <Yes/No> |
Transactions | <Yes/No> |
High Availability | <Yes/No> |
Embedded JVM support | <Yes/No> |
<links to documentation, issue list and issue reporting, E-Mail/mailing list/StackOverflow tag/twitter/other social media>
<Also, consider having a `CONTRIBUTING` file in your project to help people know how your project works and how they can help: https://github.com/blog/1184-contributing-guidelines >
<
Some optional example links:
// Link to documentation!
// Link to your repo issue list:
https://github.com/<user|org>/<repo>/issues
// Link to New Issue page to make it two steps easier:
https://github.com/<user|org>/<repo>/issues/new
// ...or use waffle.io to coordinate on GitHub issues
https://waffle.io/<user|org>/<repo>
// Link to a place where people can ask a StackOverflow question and automatically tag it
http://stackoverflow.com/questions/ask?tags=<your tag here>
// Your google group or mailing list
http://groups.google.com/group/<name>
// Have a Gitter chat room for support
https://gitter.im/<user|org>/<repo>
// Share your social media account or create one dedicated to your project
https://twitter.com/<username>
https://plus.google.com/<user or organization>
// Share a link to your local meetup group in case people want to ask you questions
http://www.meetup.com/<group name>
>