a detailed README.md

- fixed typos
- a minimal detailed example on main README.md
This commit is contained in:
ポキ 2021-01-31 23:42:24 +05:00 committed by GitHub
parent 8870717fe2
commit 6009f53fd0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions

View File

@ -1,6 +1,6 @@
# Welcome to the Python-Spam-Protection-API wiki!
This library handles All Requests done to https://api.intellivoid.net/spamprotection/v1/lookup. To understand how this is meant to be used, please see read the following [Documentation](https://github.com/intellivoid/Python-Spam-Protection-API/blob/master/docs.md)
This library handles All Requests done to https://api.intellivoid.net/spamprotection/v1/lookup. To understand how this is meant to be used, please read the following [Documentation](https://github.com/intellivoid/Python-Spam-Protection-API/blob/master/docs.md)
## Getting Started
- Installing the library:
@ -9,7 +9,7 @@ This library handles All Requests done to https://api.intellivoid.net/spamprotec
- For those who wants to try out Development Builds:
`pip install git+https://github.com/intellivoid/Python-Spam-Protection-API@dev`
`pip install git+https://github.com/intellivoid/Python-Spam-Protection-API`
## Usage
@ -17,9 +17,11 @@ This library handles All Requests done to https://api.intellivoid.net/spamprotec
from spamprotection import SPBClient
import asyncio
client = SPBClient()
loop = asyncio.get_event_loop() # asyncio loop
client = SPBClient() # spamprotection client
async def main():
async def main(): # the main function to run in async loop
user = input("Enter a Username or UserID to check Spam Prediction on SPB: ")
status = await client.check_blacklist(user)
if status.success:
@ -28,11 +30,10 @@ async def main():
print("Polish Cow did not Approve this!")
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
loop.close()
```
## Examples
All Examples are in [Examples Directory](https://github.com/intellivoid/Python-Spam-Protection-API/tree/master/examples)
All Detailed Examples are in [Examples Directory](https://github.com/intellivoid/Python-Spam-Protection-API/tree/master/examples)