mirror of
https://gitea.com/webb/teal
synced 2024-08-15 03:18:56 +00:00
Add readme
This commit is contained in:
parent
db33185ea8
commit
550eac1e0e
1 changed files with 55 additions and 0 deletions
55
README.md
Normal file
55
README.md
Normal file
|
@ -0,0 +1,55 @@
|
|||
# teal
|
||||
|
||||
This is a simple library for pxl.blue, an image hosting site. Consider this library extremely unstable
|
||||
as pxl.blue and this library are still very early in development.
|
||||
|
||||
## Examples
|
||||
|
||||
### Uploading a file using your username and password
|
||||
```
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"gitea.com/webb/teal"
|
||||
)
|
||||
|
||||
func main() {
|
||||
client, _ := teal.Login("username", "password")
|
||||
file, _ := os.Open("glenda.png")
|
||||
image, _ := client.UploadFile(file, "glenda.png")
|
||||
fmt.Println(image)
|
||||
}
|
||||
```
|
||||
|
||||
### Getting an upload key with username and password
|
||||
```
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"gitea.com/webb/teal"
|
||||
)
|
||||
|
||||
func main() {
|
||||
client, _ := teal.Login("username", "password")
|
||||
fmt.Println(client.UploadKey)
|
||||
}
|
||||
```
|
||||
|
||||
### Manually creating a barebones client and uploading a file
|
||||
|
||||
```
|
||||
import (
|
||||
"fmt"
|
||||
"gitea.com/webb/teal"
|
||||
)
|
||||
|
||||
func main() {
|
||||
client := teal.Client{
|
||||
UserAgent: "teal"
|
||||
UploadKey: "key"
|
||||
}
|
||||
file, _ := os.Open("glenda.png")
|
||||
url, _ := client.UploadFile(file, "glenda.png")
|
||||
fmt.Println(url)
|
||||
```
|
Loading…
Reference in a new issue