Browse files

Update README.md

  • Loading branch information...
1 parent 0edf6a5 commit 8ea59379775598c7f783924d7aeb3477c6f21cbf @maddenpj maddenpj committed Jan 2, 2013
Showing with 17 additions and 17 deletions.
  1. +17 −17 README.md
View
34 README.md
@@ -49,7 +49,7 @@ var dp2 = new DataPoint
* Value - the datapoint's value (double)
## Series
-Respresents metadata associated with the series. Each series has a globally unique id that is generated by the system
+Represents metadata associated with the series. Each series has a globally unique id that is generated by the system
and a user defined key. The key must be unique among all of your series. Each series may have a set of tags and attributes
that can be used to filter series during bulk reads. Attributes are key/value pairs. Both the key and attribute must be
strings. Tags are keys with no values. Tags must also be strings.
@@ -83,7 +83,7 @@ and a statistics summary table. The Summary table contains statistics for the ti
* Summary - a summary table of statistics for the queried range ( Dictionary<string, double> )
## Bulk Writes
-The Bulk classes exist to facilitate using the bulk write endpoint, which provides the ability to write to multiple series per timestamp
+The Bulk classes exist to facilitate using the bulk write endpoint, which provides the ability to write to multiple series per timestamp.
## BulkPoint
an abstract base class for the bulk data points is used, as well as 2 concrete implementations.
@@ -102,7 +102,7 @@ BulkPoint bpid = new BulkIdPoint("id", 10.0);
* Id - [BulkIdPoint] id of series being written to (string)
## BulkDataSet
-The object that represents a bulk write and is serialized and sent to the server
+The object that represents a bulk write and is serialized and sent to the server.
### Members
* Timestamp - timestamp for bulk write (DateTime)
* Data - list of bulk points ( List<BulkPoint> data )
@@ -134,7 +134,7 @@ Creates and returns a series object, optionally with the given key.
* key - [Optional] key for the series (string)
### Returns
-The newly created Series object
+The newly created Series object.
### Example
@@ -148,12 +148,12 @@ var series2 = client.CreateSeries();
```
## GetSeriesById(string id)
-Gets a specific series object
+Gets a specific series object.
### Parameters
* id - Series id (string)
### Returns
-A Series objects
+A Series objects.
### Example
@@ -164,12 +164,12 @@ var series = client.GetSeriesById("series-id");
```
## GetSeriesByKey(string key)
-Gets a specific series object
+Gets a specific series object.
### Parameters
* key - Series key (string)
### Returns
-A Series objects
+A Series objects.
### Example
@@ -180,7 +180,7 @@ var series = client.GetSeriesByKey("series-key");
```
## ListSeries(Filter filter = null)
-Returns a list of series based on a Filter object
+Returns a list of series based on a Filter object.
Using the Filter class you can construct a filter based on:
* IDs
@@ -191,7 +191,7 @@ Using the Filter class you can construct a filter based on:
* Filter - [Optional] Filter object (Filter)
### Returns
-A list of series that match the criteria
+A list of series that match the criteria.
### Example
@@ -215,7 +215,7 @@ modified. The easiest way to use this method is through a read-modify-write cycl
* series - the post updated series (Series)
### Returns
-The updated Series
+The updated Series.
### Example
@@ -272,7 +272,7 @@ A DataSet
### Example
The following example returns a data set from 2012-01-01 to 2012-01-02 for the series with id "38268c3b231f1266a392931e15e99231",
-with the maximum value for each hour as well as the raw data
+with the maximum value for each hour as well as the raw data.
```csharp
var client = new Client("api-key", "api-secret");
@@ -315,7 +315,7 @@ Writes datapoints to the specified series. The series id and a list of DataPoint
* data - the data to write (list of DataPoints)
### Returns
-Nothing
+Nothing.
### Example
@@ -341,7 +341,7 @@ if the provided key does not exist. Otherwise usage is identical to WriteById.
* data - the data to write (list of DataPoints)
### Returns
-Nothing
+Nothing.
### Example
@@ -359,7 +359,7 @@ client.WriteByKey("my-custom-key", data);
```
## WriteBulkData(BulkDataSet dataSet)
-Writes values to multiple series for a particular timestamp. This function takes a BulkDataSet which contains a timetstamp and list of BulkPoints
+Writes values to multiple series for a particular timestamp. This function takes a BulkDataSet which contains a timetstamp and list of BulkPoints.
### Parameters
* dataSet - a bulk data set representing a timestamp and multiple values (BulkDataSet)
@@ -398,7 +398,7 @@ is inclusive and the end datetime is exclusive. i.e. \[start, end)
### Returns
-Nothing
+Nothing.
### Example
@@ -420,7 +420,7 @@ is inclusive and the end datetime is exclusive. i.e. \[start, end)
### Returns
-Nothing
+Nothing.
### Example

0 comments on commit 8ea5937

Please sign in to comment.