Skip to content

Commit

Permalink
tweak README
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Mell committed Mar 24, 2012
1 parent f5e76b1 commit 880f269
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
= Polydata

Polydata takes its name from the idea of multiple hierarchies or "poly-archical"
structure of related bits of data. In a hierarchical database information can be
nested. In a polyarchy information can reside in multiple hierarchies. This is a
structure of related bits of data. In a hierarchical data structure, information can be
nested. In a polyarchy, information can be located in multiple hierarchies, in other words, a
multidimensional data structure.

This Polydata library defines a domain specific language (DSL) to implement a query-like
Expand All @@ -11,13 +11,13 @@ private key to encrypt (not sign) a timestamp. The server and client have public
and private key pairs residing on the server. The public keys are discoverable
via XRI resolution.

A polydata request is in the form of Endpoint/Authority/Type[Query]/Action[/ActionMinor]/[Requester].
A polydata request is in the form of Endpoint/Authority/Type[Query][/Action[/ActionMinor]/[Requester]].

* *Endpoint* is generally a web application available at an https url.
* *Authority* can be an XRI Canonical Id or Iname.
* *Type*, *Query* and *Action* implement the DSL.
* *Type* can be anything the server and client agree on. The only implementation
extant play fast and loose with XRIs as described here: http://en.wikipedia.org/wiki/XRI
extant plays fast and loose with XRIs as described here: http://en.wikipedia.org/wiki/XRI
* *Query* also implements the DSL. See https://github.com/mmell/polydata/blob/master/lib/polydata/type_segment.rb
* *Action* is $get or $post with an optional minor action.
* *Requester*, like Authority, can be an XRI Canonical Id or Iname.
Expand Down

0 comments on commit 880f269

Please sign in to comment.