2013-12-17 22:41:08 +01:00
ReadSharp was previously **PocketSharp.Reader** and is now hosted without the [PocketSharp ](https://github.com/ceee/PocketSharp ) dependency.
## What's it all about?
2013-12-19 11:40:47 +01:00
The library extracts the main content of a website and returns the extracted content as HTML and it's associated title, description, favicon and a all included images.
2013-12-17 22:41:08 +01:00
2013-12-17 22:42:53 +01:00
This content can be encapsulated in a `<body>` -Tag and displayed as a readable website with a custom CSS (it's up to you!).
2013-12-17 22:41:08 +01:00
2013-12-19 11:40:47 +01:00
ReadSharp is based on a custom PCL port of NReadability and SgmlReader, which are included in the solution.
#### Association with Pocket
This library is a replacement for the Article View API by Pocket, which is not only limited by usage and privacy, but also in it's way of extracting contents from websites.
2013-12-17 22:41:08 +01:00
---
2013-12-19 11:40:47 +01:00
## Example
```csharp
using ReadSharp ;
Reader reader = new Reader ();
Article article ;
try
{
article = await reader . Read ( "http://frontendplay.com/story/4/http-caching-demystified-part-2-implementation" );
}
catch ( Exception exc )
{
// handle exception
}
```
## Article Model
The `Article` contains following fields:
- `string` **Title** (the title of the page)
- `string` **Description** (description of the page, extracted from meta information)
- `string` **Content** (contains the article)
- `Uri` **FrontImage** (main page image extracted from meta tags like apple-touch-icon and others)
- `Uri` **Favicon** (the favicon of the page)
- `List<ArticleImage>` **Images** (contains all images found in the text)
- `string` **NextPage** (contains the next page URI, if available)
2013-12-17 22:41:08 +01:00
## Supported platforms
ReadSharp is a **Portable Class Library** , therefore it's compatible with multiple platforms:
- **.NET** >= 4.0.3 (including WPF)
- **Silverlight** >= 4
- **Windows Phone** >= 7.5
- **Windows Store**
## Forked Dependencies
_forks are included in the primary source code_
- [NReadability ](https://github.com/marek-stoj/NReadability )
- [SgmlReader ](https://github.com/MindTouch/SGMLReader )
## Contributors
| [](https://github.com/ceee "Tobias Klika") |
|---|
| [ceee ](https://github.com/ceee ) |
## License
[MIT License ](https://github.com/ceee/ReadSharp/blob/master/LICENSE-MIT )
