Document module repo template
This commit is contained in:
@@ -93,9 +93,10 @@ For everything else please have a look at the [detailed list][1].
|
||||
- [Domains](https://sn0int.readthedocs.io/en/latest/usage.html#domains)
|
||||
- [IPs](https://sn0int.readthedocs.io/en/latest/usage.html#ips)
|
||||
- [URLs](https://sn0int.readthedocs.io/en/latest/usage.html#urls)
|
||||
- [Scripting](https://sn0int.readthedocs.io/en/latest/scripting.html)
|
||||
- [Write your first module](https://sn0int.readthedocs.io/en/latest/scripting.html#write-your-first-module)
|
||||
- [Writing your first module](https://sn0int.readthedocs.io/en/latest/scripting.html)
|
||||
- [Creating a repository](https://sn0int.readthedocs.io/en/latest/scripting.html#creating-a-repository)
|
||||
- [Publish your module](https://sn0int.readthedocs.io/en/latest/scripting.html#publish-your-module)
|
||||
- [Publish your repo](https://sn0int.readthedocs.io/en/latest/scripting.html#publish-your-repo)
|
||||
- [Reading data from stdin](https://sn0int.readthedocs.io/en/latest/scripting.html#reading-data-from-stdin)
|
||||
- [Database](https://sn0int.readthedocs.io/en/latest/database.html)
|
||||
- [db_add](https://sn0int.readthedocs.io/en/latest/database.html#db-add)
|
||||
@@ -189,6 +190,8 @@ For everything else please have a look at the [detailed list][1].
|
||||
- [sha3_256](https://sn0int.readthedocs.io/en/latest/reference.html#sha3-256)
|
||||
- [sha3_512](https://sn0int.readthedocs.io/en/latest/reference.html#sha3-512)
|
||||
- [sleep](https://sn0int.readthedocs.io/en/latest/reference.html#sleep)
|
||||
- [sn0int_time](https://sn0int.readthedocs.io/en/latest/reference.html#sn0int-time)
|
||||
- [sn0int_time_from](https://sn0int.readthedocs.io/en/latest/reference.html#sn0int-time-from)
|
||||
- [sn0int_version](https://sn0int.readthedocs.io/en/latest/reference.html#sn0int-version)
|
||||
- [sock_connect](https://sn0int.readthedocs.io/en/latest/reference.html#sock-connect)
|
||||
- [sock_upgrade_tls](https://sn0int.readthedocs.io/en/latest/reference.html#sock-upgrade-tls)
|
||||
|
||||
@@ -14,6 +14,12 @@ free to change that to something else::
|
||||
$ git init ~/repos/sn0int-modules
|
||||
$ cd ~/repos/sn0int-modules
|
||||
|
||||
.. note::
|
||||
If you're using github you can also create a repo from the `module repo
|
||||
template`_.
|
||||
|
||||
.. _module repo template: https://github.com/sn0int/sn0int-modules
|
||||
|
||||
We need to add this folder to the sn0int config file so it's correctly detected
|
||||
when starting sn0int. Open the `config file <config.html>`_ in your prefered
|
||||
editor. Note that the file does not exist by default and the path is different
|
||||
@@ -205,6 +211,19 @@ submit pull requests. The recommended repository location is::
|
||||
|
||||
https://github.com/<your-username>/sn0int-modules
|
||||
|
||||
Publish your repo
|
||||
-----------------
|
||||
|
||||
It is highly recommended to publish your repository on github so people can
|
||||
file issues and pull requests for your module. If you've been following along
|
||||
with the github template you can simply commit your changes and push them.
|
||||
|
||||
Your repository would look like one of these:
|
||||
|
||||
- https://github.com/kpcyrd/sn0int-modules
|
||||
- https://github.com/ysf/sn0int-modules
|
||||
- https://github.com/cybiere/sn0int-modules
|
||||
|
||||
Reading data from stdin
|
||||
-----------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user