Update README.md

README.md

@@ -19,6 +19,60 @@ Arguments:
 - `-c, --config`: path to config file
 - `-d, --debug`: enable debug mode
 
+**example.com.config.js**
+
+```js
+module.exports = {
+  lang: 'fr', // program language (default: 'en')
+  site: 'example.com', // site domain name (required)
+  output: 'example.com.guide.xml', // path to output file (default: 'guide.xml')
+  channels: 'example.com.channels.xml', // path to channels.xml file (required)
+
+  /**
+   * @param {object} date The 'dayjs' instance with the requested date
+   * @param {object} channel Data about the requested channel
+   *
+   * @return {string} The function should return URL of the program page for the channel
+   */
+  url: function ({ date, channel }) {
+    return `https://example.com/${date.format('YYYY-MM-DD')}/channel/${channel.site_id}.html`
+  },
+
+  /**
+   * @param {string} content The response received after the request at the above url
+   *
+   * @return {array} The function should return an array of programs with their descriptions
+   */
+  parser: function ({ content }) {
+
+    // content parsing...
+
+    return [
+      {
+        title, // program title (required)
+        start, // program start time (required)
+        stop, // program end time (optional)
+        description, // program description (optional)
+        category // program category (optional)
+      },
+      ...
+    ]
+  }
+}
+```
+
+**example.com.channels.xml**
+
+```xml
+<?xml version="1.0"?>
+<site site="example.com">
+  <channels>
+    <channel site_id="cnn-23" xmltv_id="CNN.us">CNN</channel>
+    ...
+  </channels>
+</site>
+```
+
 ## Contribution
 
 If you find a bug or want to contribute to the code or documentation, you can help by submitting an [issue](https://github.com/freearhey/epg-grabber/issues) or a [pull request](https://github.com/freearhey/epg-grabber/pulls).