Skip to content

Commit

Permalink
added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CustomIcon committed Jan 2, 2021
1 parent 30833d0 commit 36b8403
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Welcome to the unofficial intellivoid-spam-protection 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/pokurt/intellivoid-spam-protection/wiki)

## Getting Started
- Installing the library:

`pip install git+https://github.com/pokurt/intellivoid-spam-protection`

- For those who wants to try out Development Builds:

`pip install git+https://github.com/pokurt/intellivoid-spam-protection@dev`

## Usage

```
from spamprotection import SPBClient
import asyncio
client = SPBClient()
async def main():
user = input("Enter a Username or UserID to check Spam Prediction on SPB: ")
status = await client.check_blacklist(user)
if status.success:
print((await text_parser(status.private_telegram_id)))
else:
print("Polish Cow did not Approve this!")
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
loop.close()
```
1 change: 1 addition & 0 deletions examples/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Examples Directory."""

0 comments on commit 36b8403

Please sign in to comment.