Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add overview documentation and CSS from riaknostic.

  • Loading branch information...
commit c747c38e6e843c417c60e8f42880017f08783568 1 parent 01a2d37
@seancribbs seancribbs authored
Showing with 161 additions and 0 deletions.
  1. +1 −0  .gitignore
  2. +29 −0 doc/overview.edoc
  3. +130 −0 priv/edoc.css
  4. +1 −0  rebar.config
View
1  .gitignore
@@ -4,3 +4,4 @@ priv/*
*.o
*.beam
include/riakclient_pb.hrl
+doc/*
View
29 doc/overview.edoc
@@ -0,0 +1,29 @@
+@author Basho Technologies, Inc.
+@copyright 2010-2012 Basho Technologies, Inc.
+@version 1.2.0
+@title Riak Client for Erlang
+@doc <p>The <code>riakc</code> application encapsulates the Erlang
+client for Riak. This client uses the Protocol Buffers transport
+<em>only</em>. For HTTP transport, see <a
+href="https://github.com/basho/riak-erlang-http-client">riak-erlang-http-client</a>.</p>
+
+<p>To use the client in your application, we recommend using <a
+href="https://github.com/basho/rebar">rebar</a>. Add a dependency like
+the one below to the <code>rebar.config</code> in your project.</p>
+
+<pre>{deps, [
+ {riakc, "1.2.0",
+ {git, "git://github.com/basho/riak-erlang-client",
+ {tag, "1.2.0"}}}
+ ]}.</pre>
+
+<p>The application consists of 3 modules (and a generated module for the Protocol Buffers messages):</p>
+
+<ul>
+<li><strong>riakc_pb_socket</strong> - connection management and execution of client commands. Usually you will start a connection process using <code>riakc_pb_socket:start_link/2,3</code>.</li>
+<li><strong>riakc_obj</strong> - accessor and mutator functions for the <code>riakc_obj</code> record that is sent to and returned from Key-Value operations.</li>
+<li><strong>riakc_pb</strong> - client-internal utility functions for converting message codes and Protocol Buffers messages to and from Erlang terms.</li>
+</ul>
+
+<p><code>riakc</code> is licensed under the Apache v2 license.</p>
+@end
View
130 priv/edoc.css
@@ -0,0 +1,130 @@
+/* Baseline rhythm */
+body {
+ font-size: 16px;
+ font-family: Helvetica, sans-serif;
+ margin: 8px;
+}
+
+p {
+ font-size: 1em; /* 16px */
+ line-height: 1.5em; /* 24px */
+ margin: 0 0 1.5em 0;
+}
+
+h1 {
+ font-size: 1.5em; /* 24px */
+ line-height: 1em; /* 24px */
+ margin-top: 1em;
+ margin-bottom: 0em;
+}
+
+h2 {
+ font-size: 1.375em; /* 22px */
+ line-height: 1.0909em; /* 24px */
+ margin-top: 1.0909em;
+ margin-bottom: 0em;
+}
+
+h3 {
+ font-size: 1.25em; /* 20px */
+ line-height: 1.2em; /* 24px */
+ margin-top: 1.2em;
+ margin-bottom: 0em;
+}
+
+h4 {
+ font-size: 1.125em; /* 18px */
+ line-height: 1.3333em; /* 24px */
+ margin-top: 1.3333em;
+ margin-bottom: 0em;
+}
+
+.class-for-16px {
+ font-size: 1em; /* 16px */
+ line-height: 1.5em; /* 24px */
+ margin-top: 1.5em;
+ margin-bottom: 0em;
+}
+
+.class-for-14px {
+ font-size: 0.875em; /* 14px */
+ line-height: 1.7143em; /* 24px */
+ margin-top: 1.7143em;
+ margin-bottom: 0em;
+}
+
+ul {
+ margin: 0 0 1.5em 0;
+}
+
+/* Customizations */
+body {
+ color: #333;
+}
+
+tt, code, pre {
+ font-family: "Andale Mono", "Inconsolata", "Monaco", "DejaVu Sans Mono", monospaced;
+}
+
+tt, code { font-size: 0.875em }
+
+pre {
+ font-size: 0.875em; /* 14px */
+ line-height: 1.7143em; /* 24px */
+ margin: 0 1em 1.7143em;
+ padding: 0 1em;
+ background: #eee;
+}
+
+.navbar img, hr { display: none }
+
+table {
+ border-collapse: collapse;
+}
+
+h1 {
+ border-left: 0.5em solid #fa0;
+ padding-left: 0.5em;
+}
+
+h2.indextitle {
+ font-size: 1.25em; /* 20px */
+ line-height: 1.2em; /* 24px */
+ margin: -8px -8px 0.6em;
+ background-color: #fa0;
+ color: white;
+ padding: 0.3em;
+}
+
+ul.index {
+ list-style: none;
+ margin-left: 0em;
+ padding-left: 0;
+}
+
+ul.index li {
+ display: inline;
+ padding-right: 0.75em
+}
+
+div.spec p {
+ margin-bottom: 0;
+ padding-left: 1.25em;
+ background-color: #eee;
+}
+
+h3.function {
+ border-left: 0.5em solid #fa0;
+ padding-left: 0.5em;
+ background: #fc9;
+}
+a, a:visited, a:hover, a:active { color: #C60 }
+h2 a, h3 a { color: #333 }
+
+i {
+ font-size: 0.875em; /* 14px */
+ line-height: 1.7143em; /* 24px */
+ margin-top: 1.7143em;
+ margin-bottom: 0em;
+ font-style: normal;
+}
View
1  rebar.config
@@ -3,3 +3,4 @@
{deps, [
{protobuffs, "0.6.*", {git, "git://github.com/basho/erlang_protobuffs", {tag, "protobuffs-0.6.0"}}}
]}.
+{edoc_opts, [{stylesheet_file, "./priv/edoc.css"}]}.
Please sign in to comment.
Something went wrong with that request. Please try again.