Skip to content

Commit c52d53b

Browse files
committed
add README
1 parent 2018f8a commit c52d53b

1 file changed

Lines changed: 102 additions & 0 deletions

File tree

README.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
ORIENTDB-ANDROID
2+
================
3+
4+
OrientDB-Android is a port/fork of [OrientDB](http://www.orientdb.org/) for the
5+
Android platform.
6+
7+
Currently the port removes all server implementations as they use the
8+
`javax.management.*` package, which is not part of the Android classpath.
9+
The port is designed to be used in conjunction with the
10+
[blueprints-android](https://github.com/wuman/blueprints-android) library.
11+
12+
Currently only the following modules are ported:
13+
14+
* orient-android-commons
15+
* orientdb-android-core
16+
* orientdb-android-enterprise
17+
* orientdb-android-client
18+
* orientdb-android-nativeos
19+
* orientdb-android-object
20+
* orientdb-android-tools
21+
* orientdb-android-distribution
22+
23+
Note that orientdb-android is still under development and only
24+
`orient-android-commons` and `orientdb-android-core` have been used and tested
25+
in the wild, so use it at your own risk. We welcome contributions and feedbacks.
26+
27+
The current release of orientdb-android is 1.1.0.0, which is in line with version
28+
1.1.0 of the upstream OrientDB.
29+
30+
31+
Including in Your Project
32+
-------------------------
33+
34+
There are two ways to include orientdb-android in your projects:
35+
36+
1. You can download the released jar file in the [Downloads section](https://github.com/wuman/orientdb-android/downloads).
37+
2. If you use Maven to build your project you can simply add a dependency to
38+
the desired component of the library.
39+
40+
<dependency>
41+
<groupId>com.wu-man</groupId>
42+
<artifactId>orient[db]-android-*</artifactId>
43+
<version>1.1.0.0</version>
44+
</dependency>
45+
46+
47+
Introduction to OrientDB
48+
------------------------
49+
50+
[OrientDB](http://code.google.com/p/orient/) is an open source
51+
[NoSQL](http://en.wikipedia.org/wiki/NoSQL) DBMS with both the features of
52+
Document and Graph DBMS. It's written in Java and it's amazing fast: it can store
53+
up to 150,000 records per second on common hardware.
54+
55+
OrientDB is in its core a [graph database](http://en.wikipedia.org/wiki/Graph_database),
56+
although it also offers the interface of a document database. When used a
57+
document database, the relationships are managed as in graph databases with
58+
direct connections among records. You can traverse entire or part of trees and
59+
graphs of records in few milliseconds.
60+
61+
To see how OrientDB compares with other databases, take a look at
62+
63+
* [GraphDB comparison](http://code.google.com/p/orient/wiki/GraphDBComparison)
64+
* [DocumentDB comparison](http://code.google.com/p/orient/wiki/DocumentDBComparison)
65+
66+
67+
Contribute
68+
----------
69+
70+
If you would like to contribute code you can do so through GitHub by forking
71+
the repository and sending a pull request.
72+
73+
74+
Developed By
75+
------------
76+
77+
* Android porting contributor
78+
* David Wu - <[email protected]> - [http://blog.wu-man.com](http://blog.wu-man.com)
79+
* Original contributors to OrientDB
80+
* Luca Garulli - <[email protected]> - http://www.orientechnologies.com
81+
* Luca Molino - <[email protected]>
82+
* Andrey Lomakin - <[email protected]>
83+
84+
85+
License
86+
-------
87+
88+
Copyright 2012 David Wu
89+
Copyright 2010-2012 Luca Garulli (l.garulli--at--orientechnologies.com)
90+
91+
Licensed under the Apache License, Version 2.0 (the "License");
92+
you may not use this file except in compliance with the License.
93+
You may obtain a copy of the License at
94+
95+
http://www.apache.org/licenses/LICENSE-2.0
96+
97+
Unless required by applicable law or agreed to in writing, software
98+
distributed under the License is distributed on an "AS IS" BASIS,
99+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
100+
See the License for the specific language governing permissions and
101+
limitations under the License.
102+

0 commit comments

Comments
 (0)