-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Update README.md
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,19 @@ | ||
# SnailPy - A python package to interact with Snail IDE's public APIS | ||
![costume1](https://github.com/Snail-IDE/SnailPy/assets/130254323/32ec9147-a77d-4593-9450-686b8f6e32f8) | ||
|
||
|
||
# Docs | ||
To install SnailPy, all you have to do is use the following command in the terminal | ||
```bash | ||
pip install snailpy | ||
``` | ||
Now lets make a python file, start by importing SnailPy | ||
```python | ||
import snailpy | ||
``` | ||
You should automatically see something like this in the shell | ||
```bash | ||
You are successfully using SnailPy [VERSION NUMBER HERE] | ||
``` | ||
|
||
# DOCS WIP THIS IS ALL THAT THERE IS RIGHT NOW |