Browse Source

Updated readmuhs for br0ken and spec to also contain an actual index table lm0a

Wazakindjes 3 years ago
parent
commit
b065ada6cf
2 changed files with 13 additions and 9 deletions
  1. 7 5
      br0ken/README.md
  2. 6 4
      spec/README.md

+ 7 - 5
br0ken/README.md

@@ -1,12 +1,14 @@
-This directory basically contains modules I almost finished but can't be completed due to circumstances. xd I like to keep them for reference or if (in the future) I can continue working on them. The source of these may be dirty as hell (mostly undocumented, random snippets of code for debugging, etc), deal w/ it. ;]
+This directory basically contains modules I almost finished but can't be completed due to circumstances. xd I like to keep them for reference or if (in the future) I can continue working on them. The source of these may be dirty as hell (mostly undocumented, random snippets of code for debugging, etc), fukn deal w/ it. ;]
 
 I'll be reusing the tags from the main readme (like `UNC` etc) here.
 
 # Index lol
-* [m_redirectplain (UNC)](#m_redirectplain-unc)
-* [m_splitriders](#m_splitriders)
-* [m_modmgmt](#m_modmgmt)
-* [m_wiimmfi_dsplaza (UNC)](#m_wiimmfi_dsplaza-unc)
+| Module														| Description																														|
+| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------|
+| [m_redirectplain (UNC)](#m_redirectplain-unc)					| Redirects non-SSL/TLS user connections to an SSL-enabled port																		|
+| [m_splitriders](#m_splitriders)								| Prevents users from joining restricted channels during a netsplit																	|
+| [m_modmgmt](#m_modmgmt)										| Enable loading/unload/reloading of mods (temporarily) through IRC																	|
+| [m_wiimmfi_dsplaza (UNC)](#m_wiimmfi_dsplaza-unc)				| Module to allow the `DS WiFi Plaza` to work																						|
 
 # m_redirectplain (UNC)
 Forces users who connect over a plaintext p0t (`6667` by default etc) to use SSL/TLS instead. This shit __would've__ worked if the numeric reply (`010` or `RPL_REDIR`) allowed for indication of secure p0ts. Or if a certain RFC change wasn't still in fucking `draft` status. ;_;

+ 6 - 4
spec/README.md

@@ -3,9 +3,11 @@ As you're probably already aware, the folder's name `spec` means `special reques
 __The same important notes from the main README (at the top) also apply here__
 
 # Index lol
-* [m_signore](#m_signore)
-* [m_block_nosslident](#m_block_nosslident)
-* [m_nicksuffix](#m_nicksuffix)
+| Module														| Description																														|
+| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------|
+| [m_signore](#m_signore)										| Implements an `I:Line` for adding server-side ignores																				|
+| [m_block_nosslident](#m_block_nosslident)						| Restrict certain idents to SSL connections __only__																				|
+| [m_nicksuffix](#m_nicksuffix)									| Restrict `/nick` usage to suffixing your base nick																				|
 
 # m_signore
 Requested by `Jellis` and `Stanley`. This module allows privileged opers to set a server-side ignore of sorts, making 2 users' messages invisible to each other (in private only tho, just muteban them if they shitpost in-channel or something). Servers, U:Lines and opers are exempt for obvious raisins.
@@ -36,7 +38,7 @@ __Config block:__
     };
 
 # m_nicksuffix
-Requested by `Celine` over IRC, this module prevents people from doing `/nick <anything here>`. Rather, it suffixes the "original" nick (the one on connect) with what the user specifies. There's also a special "nick" to revert back to the original one. ;] The module also comes with a new config block, which is __required__.
+Requested by `Celine`, this module prevents people from doing `/nick <anything here>`. Rather, it suffixes the "original" nick (the one on connect) with what the user specifies. There's also a special "nick" to revert back to the original one. ;] The module also comes with a new config block, which is __required__.
 
 __Updated shit:__
 * Now also disallows new users connecting with the `separator` somewhere in their nick =]