diff --git a/README.md b/README.md index 07001be..20db21f 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ $ npm install hexo-generator-feed --save - Hexo 3: 1.x - Hexo 2: 0.x +## Use + +In the [front-matter](https://hexo.io/docs/front-matter.html) of your post, you can optionally add a `description` setting to write a summary for the post. Otherwise the summary will default to the excerpt or the first 140 characters of the post. + ## Options You can configure this plugin in `_config.yml`. @@ -23,9 +27,11 @@ feed: path: atom.xml limit: 20 hub: + content: ``` - **type** - Feed type. (atom/rss2) - **path** - Feed path. (Default: atom.xml/rss2.xml) - **limit** - Maximum number of posts in the feed (Use `0` or `false` to show all posts) - **hub** - URL of the PubSubHubbub hubs (Leave it empty if you don't use it) +- **content** - (optional) set to 'true' to include the contents of the entire post in the feed.