torproject / stem

Python controller library for Tor
https://stem.torproject.org/
GNU Lesser General Public License v3.0
257 stars 75 forks source link

We can Have a general documentation for Stem Library! #146

Open aadarsh-nagrath opened 8 months ago

aadarsh-nagrath commented 8 months ago

I have created a general docs for stem! Can pull it if found suitable.

atagar commented 8 months ago

Hi Aadarsh. Thanks, but I'm concerned about duplicating information. Most of the readme seems to be copied from the FAQ. Why not simply link to the canonical source for this information?

aadarsh-nagrath commented 8 months ago

Hi Aadarsh. Thanks, but I'm concerned about duplicating information. Most of the readme seems to be copied from the FAQ. Why not simply link to the canonical source for this information?

It makes sense to avoid duplicating information but including this information in the README.md file was to create a comprehensive and user-friendly guide for Stem library users, allowing them to quickly grasp essential details without navigating to the website.