nntpchan/doc/README.md

NNTPChan Documentation
======================
**WARNING: Caching with redis was deprecated in [commit 96de42](https://github.com/majestrate/srndv2/commit/96de42bf5d689a54d27871c9f8bc4ef3d0cdbefc). Any reference to redis as a cache should be ignored. You should instead use null cache.**

Hey, welcome to the documentation. This will help you use and develop with NNTPChan.

## End-user related

1. [Building NNTPChan](building.md) -  Building the source code
2. [Setting up NNTPChan](setting-up.md) - Configuring the node
3. [Running NNTPChan](running.md) - Running the node for the first time
4. [Managing your NNTPChan node with the CLI](cli.md) -  Manage many aspects of your node via the command-line interface
5. [Moderating NNTPChan](moderation.md) - Keep your node clean
5. [Configuring your news reader for NNTPChan](extras/configure-newsreader.md) - Setup **Mozilla Thunderbird** or **Pan** to send and receive articles from your NNTPChan node of choice.

## Developer related

1. [Protocol](developer/protocol.md) - NNTPChan's protocol specification
2. [JSON-RPC API](developer/api.md) - NNTPChan's JSON-RPC API
Create README.md 2016-06-04 23:34:07 +05:00			`NNTPChan Documentation`
			`======================`
Explicit notice of redis cache deprecation Users should know that redis cache is no longer valid as of SRNDv2 commit 96de42 2016-10-08 14:08:46 +05:00			`WARNING: Caching with redis was deprecated in [commit 96de42](https://github.com/majestrate/srndv2/commit/96de42bf5d689a54d27871c9f8bc4ef3d0cdbefc). Any reference to redis as a cache should be ignored. You should instead use null cache.`
Create README.md 2016-06-04 23:34:07 +05:00
Update README.md 2016-06-05 14:37:55 +05:00			`Hey, welcome to the documentation. This will help you use and develop with NNTPChan.`

update docs 2017-04-04 18:01:43 +05:00			`## End-user related`
Update README.md 2016-06-05 00:25:14 +05:00
Update README.md 2016-06-05 00:10:17 +05:00			`1. [Building NNTPChan](building.md) - Building the source code`
			`2. [Setting up NNTPChan](setting-up.md) - Configuring the node`
			`3. [Running NNTPChan](running.md) - Running the node for the first time`
Update README.md 2016-06-05 14:36:30 +05:00			`4. [Managing your NNTPChan node with the CLI](cli.md) - Manage many aspects of your node via the command-line interface`
add docs on moderation from anon 2016-11-11 01:11:09 +05:00			`5. [Moderating NNTPChan](moderation.md) - Keep your node clean`
Update README.md 2016-07-02 17:15:59 +05:00			`5. [Configuring your news reader for NNTPChan](extras/configure-newsreader.md) - Setup Mozilla Thunderbird or Pan to send and receive articles from your NNTPChan node of choice.`
Update README.md 2016-06-05 00:25:14 +05:00
update docs 2017-04-04 18:01:43 +05:00			`## Developer related`
Update README.md 2016-06-05 00:25:14 +05:00
Update README.md 2016-06-05 14:37:33 +05:00			`1. [Protocol](developer/protocol.md) - NNTPChan's protocol specification`
			`2. [JSON-RPC API](developer/api.md) - NNTPChan's JSON-RPC API`