From fce2dadf29e6c481fcc50073d03c41f282fa7d85 Mon Sep 17 00:00:00 2001 From: Noah Date: Fri, 8 Jul 2022 18:24:14 +0100 Subject: docs: Update README.md, add it to the main docs page --- .gitignore | 4 ++++ README.md | 8 ++++++-- discord/__init__.py | 3 +++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index e3d86f5..aafa034 100644 --- a/.gitignore +++ b/.gitignore @@ -71,6 +71,10 @@ instance/ # Sphinx documentation docs/_build/ +# pdoc +docs/ +!docs/.nojekyll + # PyCharm .idea/ diff --git a/README.md b/README.md index 2b895da..cedcd8f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ -# discobra -💬🐍✨| A fast, easy to use Discord API wrapper. + + +## ⚠️ Warning + +DisCobra is still in development, and is *nowhere near finished.* Do not use it in production or for anything important. + diff --git a/discord/__init__.py b/discord/__init__.py index e69de29..066d9f5 100644 --- a/discord/__init__.py +++ b/discord/__init__.py @@ -0,0 +1,3 @@ +""" +.. include:: ../README.md +""" \ No newline at end of file -- cgit 1.4.1-2-gfad0