<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/rsspls @ main</title>
<meta name="description" content="README.md in fork/rsspls at main.">
<meta property="og:title" content="README.md - fork/rsspls @ main">
<meta property="og:description" content="README.md in fork/rsspls at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="54df30f767c777b54f558b245b0fbc66cd430fd5">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rsspls</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rsspls</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wesley Moore</span><span class="commit-message" data-commit="1dfcf83202f9699aef50390cc2e27f96d3c9af38">Refer to new website for documentation</span><span class="snapshot-sha sha" data-commit="1dfcf83202f9699aef50390cc2e27f96d3c9af38">1dfcf83</span><time datetime="2024-03-10T15:52:02+10:00" title="2024-03-10 15:52:02 +1000">2024-03-10</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a href="/fork/rsspls/ref/idna/">idna</a><a class="current" href="/fork/rsspls/ref/main/">main</a><strong>tags</strong><a href="/fork/rsspls/ref/0.10.0/">0.10.0</a><a href="/fork/rsspls/ref/0.11.0/">0.11.0</a><a href="/fork/rsspls/ref/0.11.1/">0.11.1</a><a href="/fork/rsspls/ref/0.11.2/">0.11.2</a><a href="/fork/rsspls/ref/0.12.0/">0.12.0</a><a href="/fork/rsspls/ref/0.8.1/">0.8.1</a><a href="/fork/rsspls/ref/0.9.0/">0.9.0</a><a href="/fork/rsspls/ref/0.9.0-pre/">0.9.0-pre</a><a class="all" href="/fork/rsspls/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rsspls/">rsspls</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>2.3 KiB</span><span>79 lines</span></span><span class="actions"><a class="raw" href="/fork/rsspls/raw/6e6d05aaffaf8baa36499a94e86479da3d0f6330/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;h1 align="center"&gt;
  &lt;img src="feed-icon.svg" width="48" alt=""&gt;&lt;br&gt;
  RSS Please
&lt;/h1&gt;
&lt;div align="center"&gt;
  &lt;strong&gt;A small tool (&lt;code&gt;rsspls&lt;/code&gt;) to generate RSS feeds from web
  pages that lack them. It runs on BSD, Linux, macOS, Windows, and
  more.&lt;/strong&gt;
&lt;/div&gt;
&lt;br&gt;
&lt;div align="center"&gt;
  &lt;a href="https://cirrus-ci.com/github/wezm/rsspls"&gt;
    &lt;img src="https://api.cirrus-ci.com/github/wezm/rsspls.svg" alt="Build Status"&gt;&lt;/a&gt;
  &lt;a href="https://crates.io/crates/rsspls"&gt;
    &lt;img src="https://img.shields.io/crates/v/rsspls.svg" alt="Version"&gt;
  &lt;/a&gt;
  &lt;img src="https://img.shields.io/crates/l/rsspls.svg" alt="License"&gt;
&lt;/div&gt;
&lt;br&gt;
<p><code>rsspls</code> generates RSS feeds from web pages. Example use cases:</p>
<ul>
<li>Create a feed for a blog that does not have one so that you will know when
there are new posts.</li>
<li>Create a feed from the search results on real estate agent's website so that
you know when there are new listings—without having to check manually all the
time.</li>
<li>Create a feed of the upcoming tour dates of your favourite band or DJ.</li>
<li>Create a feed of the product page for a company, so you know when new
products are added.</li>
</ul>
<p>The idea is that you will then subscribe to the generated feeds in your feed
reader. This will typically require the feeds to be hosted via a web server.</p>
<p>For more information including installation instructions, documentation, and
news visit the <a href="https://rsspls.7bit.org/">RSS Please website</a>.</p>
&lt;div align="center"&gt;
  &lt;a href="https://rsspls.7bit.org/"&gt;&lt;img src="visit-website.png" width="198" alt="Visit Website"&gt;&lt;/a&gt;
&lt;/div&gt;
<h2>Build From Source</h2>
<p><strong>Minimum Supported Rust Version:</strong> 1.70.0</p>
<p><code>rsspls</code> is implemented in Rust. See the Rust website for <a href="https://www.rust-lang.org/tools/install">instructions on
installing the toolchain</a>.</p>
<h3>From Git Checkout or Release Tarball</h3>
<p>Build the binary with <code>cargo build --release --locked</code>. The binary will be in
<code>target/release/rsspls</code>.</p>
<h3>From crates.io</h3>
<p><code>cargo install rsspls</code></p>
<h2>Credits</h2>
<ul>
<li><a href="http://www.feedicons.com/">RSS feed icon</a> by The Mozilla Foundation</li>
</ul>
<h2>Licence</h2>
<p>This project is dual licenced under either of:</p>
<ul>
<li>Apache License, Version 2.0 (<a href="https://github.com/wezm/rsspls/blob/master/LICENSE-APACHE">LICENSE-APACHE</a>)</li>
<li>MIT license (<a href="https://github.com/wezm/rsspls/blob/master/LICENSE-MIT">LICENSE-MIT</a>)</li>
</ul>
<p>at your option.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>&lt;</a-p><a-tg>h1</a-tg> <a-at>align</a-at>=&quot;<a-s>center</a-s>&quot;<a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>feed-icon.svg</a-s><a-p>&quot; </a-p><a-at>width</a-at><a-p>=&quot;</a-p><a-s>48</a-s><a-p>&quot; </a-p><a-at>alt</a-at><a-p>=&quot;&quot;&gt;&lt;</a-p><a-tg>br</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>  RSS Please</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>h1</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>&lt;</a-p><a-tg>div</a-tg><a-p> </a-p><a-at>align</a-at><a-p>=&quot;</a-p><a-s>center</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>strong</a-tg><a-p>&gt;A small tool (&lt;</a-p><a-tg>code</a-tg><a-p>&gt;rsspls&lt;/</a-p><a-tg>code</a-tg><a-p>&gt;) to generate RSS feeds from web</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>  pages that lack them. It runs on BSD, Linux, macOS, Windows, and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>  more.&lt;/</a-p><a-tg>strong</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>div</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>&lt;</a-p><a-tg>br</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>&lt;</a-p><a-tg>div</a-tg><a-p> </a-p><a-at>align</a-at><a-p>=&quot;</a-p><a-s>center</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://cirrus-ci.com/github/wezm/rsspls</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://api.cirrus-ci.com/github/wezm/rsspls.svg</a-s><a-p>&quot; </a-p><a-at>alt</a-at><a-p>=&quot;</a-p><a-s>Build Status</a-s><a-p>&quot;&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://crates.io/crates/rsspls</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>    &lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/crates/v/rsspls.svg</a-s><a-p>&quot; </a-p><a-at>alt</a-at><a-p>=&quot;</a-p><a-s>Version</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>  &lt;/</a-p><a-tg>a</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>https://img.shields.io/crates/l/rsspls.svg</a-s><a-p>&quot; </a-p><a-at>alt</a-at><a-p>=&quot;</a-p><a-s>License</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>div</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>&lt;</a-p><a-tg>br</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>`rsspls` generates RSS feeds from web pages. Example use cases:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>* Create a feed for a blog that does not have one so that you will know when</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>  there are new posts.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>* Create a feed from the search results on real estate agent&#39;s website so that</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>  you know when there are new listings—without having to check manually all the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>  time.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>* Create a feed of the upcoming tour dates of your favourite band or DJ.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>* Create a feed of the product page for a company, so you know when new</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>  products are added.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>The idea is that you will then subscribe to the generated feeds in your feed</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>reader. This will typically require the feeds to be hosted via a web server.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>For more information including installation instructions, documentation, and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>news visit the [RSS Please website][website].</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>&lt;</a-p><a-tg>div</a-tg><a-p> </a-p><a-at>align</a-at><a-p>=&quot;</a-p><a-s>center</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>https://rsspls.7bit.org/</a-s><a-p>&quot;&gt;&lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>visit-website.png</a-s><a-p>&quot; </a-p><a-at>width</a-at><a-p>=&quot;</a-p><a-s>198</a-s><a-p>&quot; </a-p><a-at>alt</a-at><a-p>=&quot;</a-p><a-s>Visit Website</a-s><a-p>&quot;&gt;&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>div</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-tt>Build From Source</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>-----------------</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>**Minimum Supported Rust Version:** 1.70.0</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>`rsspls` is implemented in Rust. See the Rust website for [instructions on</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>installing the toolchain][rustup].</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>### </a-p><a-tt>From Git Checkout or Release Tarball</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>Build the binary with `cargo build --release --locked`. The binary will be in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>`target/release/rsspls`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>### </a-p><a-tt>From crates.io</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>`cargo install rsspls`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-tt>Credits</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>-------</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>* [RSS feed icon](http://www.feedicons.com/) by The Mozilla Foundation</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-tt>Licence</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>-------</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>This project is dual licenced under either of:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/wezm/rsspls/blob/master/LICENSE-APACHE))</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>- MIT license ([LICENSE-MIT](https://github.com/wezm/rsspls/blob/master/LICENSE-MIT))</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>at your option.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-tu>[rustup]</a-tu><a-p>: </a-p><a-tu>https://www.rust-lang.org/tools/install</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-tu>[website]</a-tu><a-p>: </a-p><a-tu>https://rsspls.7bit.org/</a-tu></span></span></pre></div></div>
</main>
</body>
</html>
