From 94340e5cf52715474c16640198721f6f14a2faee Mon Sep 17 00:00:00 2001 From: Tobias Klika Date: Fri, 24 Jan 2014 00:25:10 +0100 Subject: [PATCH] update readme with ReadOptions --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 52b1299..f51d837 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,8 @@ catch (ReadException exc) ## Options +### HttpOptions + You can pass `HttpOptions` to the `Reader` constructor, which count for all requests: - `HttpMessageHandler` **CustomHttpHandler**
Use your own HTTP handler @@ -52,6 +54,15 @@ You can pass `HttpOptions` to the `Reader` constructor, which count for all requ - `string` **UserAgent**
Override the user agent, which is passed to the destination server - `bool` **UseMobileUserAgent**
There are desktop and mobile default user agents. By enabling this property, the mobile user agent is used. _If you pass a custom user agent, this property is ignored!_ +### ReadOptions + +There are also `ReadOptions` available, which are passed on every request: + +- `bool` **HasHeaderTags**
Return complete HTML document or just the body part +- `bool` **HasNoHeadline**
Removes `

` title from the article +- `bool` **UseDeepLinks**
If you check this option, deep-links (containing hashes, e.g. `href="#article"`) are not transformed into absolute URIs +- `bool` **PrettyPrint**
Determines whether the HTML output will be formatted + ## Article Model The `Article` contains following fields: