README.md

![PocketSharp](https://raw.github.com/ceee/PocketSharp/master/Assets/github-header.png)

**PocketSharp** is a C#.NET portable class library that integrates the [Pocket API v3](http://getpocket.com/developer).

## Install using [NuGet](https://www.nuget.org/packages/PocketSharp/)

```
Install-Package PocketSharp
```

## Documentation

See [wiki](https://github.com/ceee/PocketSharp/wiki)

---

## Usage Example:

A search for items containing `CSS`:

```csharp
PocketClient client = new PocketClient("[YOUR_CONSUMER_KEY]", "[YOUR_ACCESS_CODE]");

List<PocketItem> items = await client.Search("css");

items.ForEach(
	item => Debug.WriteLine(item.ID + " | " + item.Title)
);
```

Which will output:

    330361896 | CSS Front-end Frameworks with comparison : By usabli.ca
    345541438 | Editr - HTML, CSS, JavaScript playground
    251743431 | CSS Architecture
    343693149 | CSS3 Transitions - Thank God We Have A Specification!
	...

---


## Supported platforms

PocketSharp is a **Portable Class Library** (since 1.0.0), therefore it's compatible with multiple platforms:

- **.NET** >= 4.5 (including WPF)
- **Silverlight** >= 4
- **Windows Phone** >= 7.5
- **Windows Store**

You can find examples for Silverlight 5, WP8 and WPF in the `PocketSharp.Examples` ([@github](https://github.com/ceee/PocketSharp/tree/master/PocketSharp.Examples)) folder.

## What's next?

- `cancellationToken` support for all methods

## Dependencies

- [Microsoft.Bcl.Async](https://www.nuget.org/packages/Microsoft.Bcl.Async/)
- [Microsoft.Net.Http](https://www.nuget.org/packages/Microsoft.Net.Http/)
- [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/)
- [PropertyChanged.Fody](https://github.com/Fody/PropertyChanged)

## Forked Dependencies

- [NReadability](https://github.com/marek-stoj/NReadability) - converted to a PCL with minor adaptations
- [SgmlReader](https://github.com/MindTouch/SGMLReader) - converted to a PCL

## Contributors
| [![ceee](http://gravatar.com/avatar/9c61b1f4307425f12f05d3adb930ba66?s=70)](https://github.com/ceee "Tobias Klika") | [![ScottIsAFool](http://gravatar.com/avatar/6df656872a87b09a7470feb4867ed927?s=70)](https://github.com/ScottIsAFool "Scott Lovegrove") |
|---|---|
| [ceee](https://github.com/ceee) | [ScottIsAFool](https://github.com/ScottIsAFool) |

## License

[MIT License](https://github.com/ceee/PocketSharp/blob/master/LICENSE-MIT)
remove website 2013-11-01 16:38:24 +01:00			`![PocketSharp](https://raw.github.com/ceee/PocketSharp/master/Assets/github-header.png)`
update readme 2013-09-05 21:58:13 +02:00
Update README.md 2013-10-21 22:12:53 +02:00			`PocketSharp is a C#.NET portable class library that integrates the [Pocket API v3](http://getpocket.com/developer).`
add Console application for internal testing; 2013-06-13 13:34:41 +02:00
update version 2013-10-25 15:19:42 +02:00			`## Install using [NuGet](https://www.nuget.org/packages/PocketSharp/)`
update documentation; 2013-07-02 20:58:13 +02:00
Update README.md 2013-07-29 22:22:05 +02:00			```
			`Install-Package PocketSharp`
			```
update documentation; 2013-07-02 20:58:13 +02:00
update documentation and website 2013-10-17 15:34:05 +02:00			`## Documentation`
update readme 2013-09-29 23:22:03 +02:00
update version 2013-10-25 15:19:42 +02:00			`See [wiki](https://github.com/ceee/PocketSharp/wiki)`
update readme 2013-09-29 23:22:03 +02:00
Update README.md 2013-10-23 20:26:40 +02:00			`---`

			`## Usage Example:`

			A search for items containing `CSS`:

			```csharp
Update README.md 2013-10-23 20:27:19 +02:00			`PocketClient client = new PocketClient("[YOUR_CONSUMER_KEY]", "[YOUR_ACCESS_CODE]");`
Update README.md 2013-10-23 20:26:40 +02:00
Update README.md 2013-10-23 20:27:19 +02:00			`List<PocketItem> items = await client.Search("css");`
Update README.md 2013-10-23 20:26:40 +02:00
			`items.ForEach(`
			`item => Debug.WriteLine(item.ID + " \| " + item.Title)`
			`);`
			```

			`Which will output:`

			`330361896 \| CSS Front-end Frameworks with comparison : By usabli.ca`
			`345541438 \| Editr - HTML, CSS, JavaScript playground`
			`251743431 \| CSS Architecture`
			`343693149 \| CSS3 Transitions - Thank God We Have A Specification!`
			`...`

			`---`


update website and docs 2013-09-15 15:46:13 +02:00			`## Supported platforms`

			`PocketSharp is a Portable Class Library (since 1.0.0), therefore it's compatible with multiple platforms:`

update version 2013-10-25 15:19:42 +02:00			`- .NET >= 4.5 (including WPF)`
update website and docs 2013-09-15 15:46:13 +02:00			`- Silverlight >= 4`
			`- Windows Phone >= 7.5`
			`- Windows Store`

update docs 2013-09-17 23:28:28 +02:00			You can find examples for Silverlight 5, WP8 and WPF in the `PocketSharp.Examples` ([@github](https://github.com/ceee/PocketSharp/tree/master/PocketSharp.Examples)) folder.
update website and docs 2013-09-15 15:46:13 +02:00
Update README.md 2013-10-23 20:26:40 +02:00			`## What's next?`

			- `cancellationToken` support for all methods
add first version of documentation; 2013-06-26 14:16:07 +02:00
update readme 2013-07-09 23:13:06 +02:00			`## Dependencies`
update documentation; 2013-07-02 21:15:57 +02:00
update website and docs 2013-09-15 15:46:13 +02:00			`- [Microsoft.Bcl.Async](https://www.nuget.org/packages/Microsoft.Bcl.Async/)`
			`- [Microsoft.Net.Http](https://www.nuget.org/packages/Microsoft.Net.Http/)`
			`- [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/)`
update version 2013-10-25 15:19:42 +02:00			`- [PropertyChanged.Fody](https://github.com/Fody/PropertyChanged)`
update documentation; 2013-07-02 21:15:57 +02:00
Update README.md 2013-10-21 22:12:53 +02:00			`## Forked Dependencies`

			`- [NReadability](https://github.com/marek-stoj/NReadability) - converted to a PCL with minor adaptations`
			`- [SgmlReader](https://github.com/MindTouch/SGMLReader) - converted to a PCL`

initial 2013-06-13 11:07:27 +02:00			`## Contributors`
update contributors 2013-10-25 15:22:13 +02:00			`\| [![ceee](http://gravatar.com/avatar/9c61b1f4307425f12f05d3adb930ba66?s=70)](https://github.com/ceee "Tobias Klika") \| [![ScottIsAFool](http://gravatar.com/avatar/6df656872a87b09a7470feb4867ed927?s=70)](https://github.com/ScottIsAFool "Scott Lovegrove") \|`
			`\|---\|---\|`
			`\| [ceee](https://github.com/ceee) \| [ScottIsAFool](https://github.com/ScottIsAFool) \|`
update version 2013-10-25 15:19:42 +02:00
update readme 2013-07-09 23:13:06 +02:00			`## License`

Update README.md 2013-07-29 22:22:05 +02:00			`[MIT License](https://github.com/ceee/PocketSharp/blob/master/LICENSE-MIT)`