Add examples to docs (#28)

* Add example

* update setup.py

Author: Genteki

docs/README.md

@@ -1,7 +1,8 @@
-# Introduction to pyvts
+# pyvts
 [![License: MIT](https://img.shields.io/github/license/Genteki/pyvts?style=flat-square)](https://opensource.org/licenses/MIT) [![issue](https://img.shields.io/github/issues/genteki/pyvts?style=flat-square)](https://github.com/Genteki/pyvts/issues) [![build](https://img.shields.io/circleci/build/github/Genteki/pyvts?style=flat-square)](https://circleci.com/gh/Genteki/pyvts)
 [![codecov](https://img.shields.io/codecov/c/github/genteki/pyvts?color=informational&style=flat-square)](https://codecov.io/gh/Genteki/pyvts)
 [![PyPI](https://img.shields.io/pypi/v/pyvts?style=flat-square)](https://pypi.org/project/pyvts/)
+[![docs](https://img.shields.io/badge/docs-passing-success?style=flat-square)](https://genteki.github.io/pyvts)
 
 A python library for interacting with the [VTube Studio API](https://github.com/DenchiSoft/VTubeStudio).
 
@@ -49,7 +50,7 @@ if __name__ == "__main__":
 
 ### Demo
 
-Demo [examples/start.py](https://github.com/Genteki/pyvts/blob/main/examples/start.py) is a good startpoint to make plugin for VTubeStudio. 
+Demo [examples/start.py](./examples/start.py) is a good startpoint to make plugin for VTubeStudio. 
 
 Before you get started, make sure you've clone the library and installed all the dependcies
 

docs/basicusage.md

@@ -0,0 +1,55 @@
+### Basic Usage
+
+First import packages
+
+```
+import asyncio, pyvts
+```
+
+Then specify your plugin info, you can use the default value and skip this step,
+
+```
+plugin_info = {
+    "plugin_name": "start pyvts",
+    "developer": "Genteki",
+    "authentication_token_path": "./token.txt"
+}
+```
+
+Use ``async`` prefix to define a `main` function. Creat `vts` instance in `main`.
+
+```
+async def main():
+    myvts = pyvts.vts(plugin_info=plugin_info)
+    await myvts.connect()
+```
+
+After sucessfully connected, you will see in VTubeStudio settings
+
+![](./image/example_start_plugin_connected.png)
+
+Continue with `main` function, to get access of more features, we need to get authenticated from `Vtube Studio API`.
+
+```
+    await vts.request_authenticate_token()  # get token
+    await vts.request_authenticate()  # use token
+```
+
+In `vts.request_authenticate_token`, it will request a token from `Vtube Studio API`, and save it in local file. While requesting token, a dialog will show up in VTube Studio app. Then, `vts.request_authenticate` will use the token to get accessed.
+
+![](./image/example_start_1.png)
+
+Then you can do whatever you want, like add a new parameter/set values for parameter.
+
+```
+    new_parameter_name = "start_parameter"
+    await vts.request(
+        vts.vts_request.requestCustomParameter(new_parameter_name)
+    )  # add new parameter
+```
+
+After all, use `vts.close()` to disconnect from VTS and add `main` function to `async` quene.
+```
+    if __name__ == "__main__":
+        async.run(main())
+```

docs/image/example_start_1.png

@@ -3,6 +3,7 @@
 [![License: MIT](https://img.shields.io/github/license/Genteki/pyvts?style=flat-square)](https://opensource.org/licenses/MIT) [![issue](https://img.shields.io/github/issues/genteki/pyvts?style=flat-square)](https://github.com/Genteki/pyvts/issues) [![build](https://img.shields.io/circleci/build/github/Genteki/pyvts?style=flat-square)](https://circleci.com/gh/Genteki/pyvts)
 [![codecov](https://img.shields.io/codecov/c/github/genteki/pyvts?color=informational&style=flat-square)](https://codecov.io/gh/Genteki/pyvts)
 [![PyPI](https://img.shields.io/pypi/v/pyvts?style=flat-square)](https://pypi.org/project/pyvts/)
+[![docs](https://img.shields.io/badge/docs-passing-success?style=flat-square)](https://genteki.github.io/pyvts)
 
 ## Overview
 `pyvts` is a python library for interacting with the [VTube Studio API](https://github.com/DenchiSoft/VTubeStudio).
@@ -23,6 +24,8 @@ README.md
    :caption: Introduction to pyvts
    :end-before: Demo
    :heading-offset: 3
+tutorial.rst
+   :caption: Tutorial
 reference.rst
    :caption: API reference 
    :depth: 1

docs/image/example_start_plugin_connected.png

@@ -0,0 +1,4 @@
+## Tutorial
+
+```{include} basicusage.md
+```

docs/index.md

@@ -4,7 +4,7 @@
 
 """
 
-__version__ = "0.1.1"
+__version__ = "0.2.0"
 __all__ = ["vts", "vts_request", "config", "error"]
 
 from .vts import vts

docs/tutorial.md

@@ -1,4 +1,3 @@
-
 """A python library for interacting with the VTube Studio API"""
 
 from setuptools import setup, find_packages
@@ -7,27 +6,29 @@
 DESCRIPTION = "A python library for interacting with the VTube Studio API"
 VERSION = pyvts.__version__
 
-setup(name='pyvts',
-      version=VERSION,
-      description=DESCRIPTION,
-      long_description=open("README.md", encoding="utf-8").read(),
-      long_description_content_type='text/markdown',
-      keywords='vtubestudio',
-      classifiers=['Development Status :: 3 - Alpha',
-                   'Intended Audience :: Developers',
-                   'License :: OSI Approved :: MIT License',
-                   'Operating System :: Microsoft :: Windows',
-                   'Operating System :: MacOS',
-                   'Programming Language :: Python',
-                   'Programming Language :: Python :: 3',
-                   'Programming Language :: Python :: 3.8',
-                   'Programming Language :: Python :: 3.9',
-                   'Programming Language :: Python :: 3.10'],
-      author='Genteki Zhang',
-      author_email='zhangkaiyuan.null@gmail.com',
-      url='https://github.com/Genteki/pyvts',
-      license='MIT',
-      packages=find_packages(exclude=['*.tests',
-                                      '*.tests.*']),
-      install_requires=['websockets',
-                        'aiofile'])
+setup(
+    name="pyvts",
+    version=VERSION,
+    description=DESCRIPTION,
+    long_description=open("README.md", encoding="utf-8").read(),
+    long_description_content_type="text/markdown",
+    keywords="vtubestudio",
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: MacOS",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+    ],
+    author="Genteki Zhang",
+    author_email="zhangkaiyuan.null@gmail.com",
+    url="https://github.com/Genteki/pyvts",
+    license="MIT",
+    packages=find_packages(where="pyvts", exclude=["tests.*", "tests"]),
+    install_requires=["websockets", "aiofile"],
+)