Skip to content

Commit 9688cb0

Browse files
committed
New github-centric readme
1 parent 3cf8cda commit 9688cb0

File tree

2 files changed

+40
-23
lines changed

2 files changed

+40
-23
lines changed

README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Objectify is a Java data access API specifically designed for the Google App Engine datastore. It occupies a
2+
"middle ground"; easier to use and more transparent than JDO or JPA, but significantly more convenient than
3+
the Low-Level API. Objectify is designed to make novices immediately productive yet also expose the full power
4+
of the GAE datastore.
5+
6+
* Objectify lets you persist, retrieve, delete, and query your own **typed objects**.
7+
```
8+
@Entity
9+
class Car {
10+
@Id String vin; // Can be Long, long, or String
11+
String color;
12+
}
13+
14+
ofy().save().entity(new Car("123123", "red")).now();
15+
Car c = ofy().load().type(Car.class).id("123123").now();
16+
ofy().delete().entity(c);
17+
```
18+
* Objectify surfaces **all native datastore features**, including batch operations, queries, transactions, asynchronous operations, and partial indexes.
19+
* Objectify provides **type-safe key and query classes** using Java generics.
20+
* Objectify provides a **human-friendly query interface**.
21+
* Objectify can automatically **cache your data in memcache** for improved read performance.
22+
* Objectify can store polymorphic entities and perform **true polymorphic queries**.
23+
* Objectify provides a simple, **easy-to-understand transaction model**.
24+
* Objectify provides built-in facilities to **help migrate schema changes** forward.
25+
* Objectify provides **thorough documentation** of concepts as well as use cases.
26+
* Objectify has an **extensive test suite** to prevent regressions.
27+
28+
# Documentation
29+
30+
Full documentation is availble in the [Objectify Wiki](https://github.com/objectify/objectify/wiki).
31+
32+
# Downloads
33+
34+
Objectify is released to the [Maven Central Repository](https://github.com/objectify/objectify/wiki/MavenRepository)
35+
and can be downloaded directly from there.
36+
37+
# Help
38+
39+
Help is provided in the
40+
[Objectify App Engine User Group](https://groups.google.com/forum/?fromgroups#!forum/objectify-appengine)

README.mkd

-23
This file was deleted.

0 commit comments

Comments
 (0)