Add Alternatives & Prior Art section to readme

type: documentation
casey · Apr 8, 2020 · 48ca86c · 48ca86c
1 parent ef5be39
commit 48ca86c
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@
 - [Bittorrent](#bittorrent)
   - [BEP Support](#bep-support)
 - [References](#references)
+  - [Alternatives & Prior Art](#alternatives--prior-art)
   - [BitTorrent](#bittorrent)
 
 ## General
@@ -132,6 +133,24 @@ at any time.
 
 ## References
 
+### Alternatives & Prior Art
+
+| Name                                                                              | UI                      | Language   | Notes                                                                                                                                     |
+|-----------------------------------------------------------------------------------|-------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| [torf-cli](https://github.com/rndusr/torf-cli)                                    | CLI                     | Python     | Highly recommended utility for creating torrents and magnet links, as well as displaying information about and editing existing torrents. |
+| [mktorrent](https://github.com/Rudde/mktorrent)                                   | CLI                     | C          | Popular but unmaintained torrent file creator.                                                                                            |
+| [pmktorrent](https://github.com/xxkfqz/pmktorrent)                                | CLI                     | C          | Maintained fork of mktorrent.                                                                                                             |
+| [mktorrent](https://github.com/mukaibot/mktorrent)                                | Library                 | Ruby       | Library for creating torrent files.                                                                                                       |
+| [py3createtorrent](https://github.com/rsnitsch/py3createtorrent/)                 | CLI                     | Python     | Torrent file creator.                                                                                                                     |
+| [create-torrent](https://github.com/webtorrent/create-torrent)                    | Library&nbsp;&&nbsp;CLI | JavaScript | Javascript library and CLI for creating torrents.                                                                                         |
+| [whatmp3](https://github.com/RecursiveForest/whatmp3)                             | CLI                     | Python     | Torrent file creator that automatically transcodes FLAC files.                                                                            |
+| [torrent-file-editor](https://github.com/torrent-file-editor/torrent-file-editor) | GUI                     | C++        | Graphical torrent file editor.                                                                                                            |
+| [torrent2magnet](https://github.com/repolho/torrent2magnet)                       | CLI                     | Python     | Creates magnet links from torrent files.                                                                                                  |
+| [h2torrent](https://github.com/elektito/ih2torrent)                               | CLI                     | Python     | Creates .torrent files from an infohash or magnet URI.                                                                                    |
+| [dottorrent](https://github.com/kz26/dottorrent)                                  | Library                 | Python     | Library for creating torrent files                                                                                                        |
+| [dottorrent-cli](https://github.com/kz26/dottorrent-cli)                          | CLI                     | Python     | Torrent file creator.                                                                                                                     |
+| [torrent-creator](https://github.com/kimbatt/torrent-creator/)                    | Web page                | Typescript | Single-page web app torrent file creator.                                                                                                 |
+
 ### BitTorrent
 
 | URL                                                         | Description                                                                                       |

diff --git a/bin/update-readme/src/opt.rs b/bin/update-readme/src/opt.rs
@@ -31,7 +31,11 @@ impl Opt {
       let text = captures.name("TEXT").unwrap().as_str();
       let level = marker.len();
       let indentation = " ".repeat((level - 2) * 2);
-      let slug = text.to_lowercase().replace(' ', "-").replace('.', "");
+      let slug = text
+        .to_lowercase()
+        .replace(' ', "-")
+        .replace('.', "")
+        .replace('&', "");
       toc.push(format!("{}- [{}](#{})", indentation, text, slug));
     }