update readme

PocketSharp.Website/index.html

@@ -33,7 +33,7 @@
       <p class="app-description">
         PocketSharp is a C#.NET class library, that integrates the Pocket API v3
         <br><br>
-        Current version: <b>1.4.0</b><br>
+        Current version: <b>1.5.0</b><br>
         <a href="https://www.nuget.org/packages/PocketSharp/">@ nuget</a>
       </p>
       <div class="app-nuget">
@@ -48,8 +48,8 @@
     <div class="app-main">
       <nav class="app-nav">
         <a href="#" data-id="gettingstarted" class="is-active">Getting Started</a>
-        <a href="#" data-id="authentication">Authentication</a>
-        <a href="#" data-id="retrieve">Retrieve</a>
+        <a href="#" data-id="account">Account</a>
+        <a href="#" data-id="get">Get</a>
         <a href="#" data-id="add">Add</a>
         <a href="#" data-id="modify">Modify</a>
       </nav>
@@ -125,6 +125,7 @@ using PocketSharp.Models;</code></pre>
 
           <h2>Release History</h2>
         <ul>
+          <li><b>1.5.0</b> (2013-09-28) add statistics and registration API</li>
           <li><b>1.4.0</b> (2013-09-21) rename <code>Retrieve</code> to <code>Get</code> + update IntelliSense documentation + add <code>GetTags</code> method
           <li><b>1.3.0</b> (2013-09-19) get Item by ID + tag modification bugfixes</li>
           <li><b>1.2.1</b> (2013-09-18) correct parameter conversion for DateTime and Boolean</li>
@@ -152,7 +153,7 @@ using PocketSharp.Models;</code></pre>
 
 
 
-      <div data-part="authentication">
+      <div data-part="account">
 
 
         <h2>Authentication</h2>
@@ -188,12 +189,20 @@ Note that <code>GetAccessCode</code> can only be called with an existing <em>req
           Without it you would always have to redo the authentication process.
         </p>
 
+        <h2>Account Registration</h2>
+<p>The <code>RegisterAccount</code> method exists in Pocket API v3, but is currently undocumented.
+<br>The user cannot authenticate directly after registration, as the account has to be activated via an opt-in link, which is sent to the e-mail address.</p>
+<pre class="language-clike"><code>bool isSuccess = await _client.RegisterAccount(&quot;myUsername&quot;, &quot;me@mymail.com&quot;, &quot;mypassword&quot;);
+</code></pre>
+
+<p>After registration you have to remind the user to check his/her mail account.</p>
+
       </div>
 
 
-      <div data-part="retrieve">
+      <div data-part="get">
 
-        <h2>Retrieve</h2>
+        <h2>Get</h2>
 
 <p>Get list of all items:</p>
 <p><pre class="language-clike"><code>List&lt;PocketItem&gt; items = await _client.Get();
@@ -226,6 +235,11 @@ Note that <code>GetAccessCode</code> can only be called with an existing <em>req
 // returns favorites only</code></pre></p>
 <p>The RetrieveFilter Enum is specified as follows:</p>
 <p><pre class="language-clike"><code>enum RetrieveFilter { All, Unread, Archive, Favorite, Article, Video, Image }</code></pre></p>
+<h2>Statistics</h2>
+<p>The Pocket API supports retrieval of a simple statistics object.</p>
+<pre class="language-clike">PocketStatistics statistics = await client.Statistics();
+// PocketStatistics: [CountAll], [CountRead], [CountUnread]
+</code></pre>
       </div>
 
       <div data-part="add">

README.md

@@ -1,17 +1,27 @@
 ![PocketSharp](https://raw.github.com/ceee/PocketSharp/master/PocketSharp.Website/Assets/Images/github-header.png)
 
-**PocketSharp** is a C#.NET class library, that integrates the [Pocket API v3](http://getpocket.com/developer) and consists of 4 parts: [Authentication](#authentication), [Retrieve](#retrieve), [Modify](#modify) and [Add](#add).
+**PocketSharp** is a C#.NET class library, that integrates the [Pocket API v3](http://getpocket.com/developer).
 
 **Website:** [pocketsharp.frontendplay.com](http://pocketsharp.frontendplay.com/)
 <br>
 **NuGet:** [nuget.org/packages/PocketSharp](https://www.nuget.org/packages/PocketSharp/)
 
+
 ## Install using NuGet
 
 ```
 Install-Package PocketSharp
 ```
 
+## Components
+
+- [Get](#get) - Retrieve and search for items
+- [Modify](#modify) - Modify items and its tags
+- [Add](#add) - Add new items
+- [Authentication](#account-authentication) - Authenticate users
+- [Registration](#account-registration) - Register new users
+- [Statistics](#statistics) - Retrieve account statistics
+
 ## Supported platforms
 
 PocketSharp is a **Portable Class Library** (since 1.0.0), therefore it's compatible with multiple platforms:
@@ -103,7 +113,7 @@ _client.AccessCode = "[YOU_ACCESS_CODE]";
 <br>
 **After authentication** you will need to provide the `accessCode`.
 
-## Authentication
+## Account Authentication
 
 In order to communicate with a Pocket User, you will need a consumer key (which is generated by [creating a new application on Pocket](http://getpocket.com/developer/apps/)) and an **Access Code**.
 
@@ -144,7 +154,16 @@ Note that `GetAccessCode` can only be called with an existing _request code_. If
 <br>
 Without it you would always have to redo the authentication process.
 
-## Retrieve
+## Account Registration
+
+The `RegisterAccount` method exists in Pocket API v3, but is currently undocumented.
+<br>The user cannot authenticate directly after registration, as the account has to be activated via an opt-in link, which is sent to the e-mail address.
+
+	bool isSuccess = await _client.RegisterAccount("myUsername", "me@mymail.com", "mypassword");
+
+After registration you have to remind the user to check his/her mail account.
+
+## Get
 
 Get list of all items:
 
@@ -281,6 +300,13 @@ Renames a tag for the specified item:
 
 	bool isSuccess = await _client.RenameTag(myPocketItem, "oldTagName", "newTagName");
 
+## Statistics
+
+The Pocket API supports retrieval of a simple statistics object.
+
+	PocketStatistics statistics = await client.Statistics();
+	// PocketStatistics: [CountAll], [CountRead], [CountUnread]
+
 ---
 
 ## Release History