docs(readme): add basic readme

This commit is contained in:
2022-12-11 21:50:45 +00:00
parent 64c7d250a1
commit e742d43b36

49
README.md Normal file
View File

@@ -0,0 +1,49 @@
<h1 align="center">
go-midjourney
</h1>
<p align="center">
<strong>
Experimental and unfinished Go package for interacting the unofficial
MidJourney API powering midjourney.com.
</strong>
</p>
<p align="center">
<a href="https://pkg.go.dev/github.com/jimeh/go-midjourney">
<img src="https://img.shields.io/badge/%E2%80%8B-reference-387b97.svg?logo=go&logoColor=white"
alt="Go Reference">
</a>
<a href="https://github.com/jimeh/go-midjourney/releases">
<img src="https://img.shields.io/github/v/tag/jimeh/go-midjourney?label=release" alt="GitHub tag (latest SemVer)">
</a>
<a href="https://github.com/jimeh/go-midjourney/actions">
<img src="https://img.shields.io/github/workflow/status/jimeh/go-midjourney/CI.svg?logo=github" alt="Actions Status">
</a>
<a href="https://github.com/jimeh/go-midjourney/issues">
<img src="https://img.shields.io/github/issues-raw/jimeh/go-midjourney.svg?style=flat&logo=github&logoColor=white"
alt="GitHub issues">
</a>
<a href="https://github.com/jimeh/go-midjourney/pulls">
<img src="https://img.shields.io/github/issues-pr-raw/jimeh/go-midjourney.svg?style=flat&logo=github&logoColor=white" alt="GitHub pull requests">
</a>
<a href="https://github.com/jimeh/go-midjourney/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/jimeh/go-midjourney.svg?style=flat" alt="License Status">
</a>
</p>
## Import
```go
import "github.com/jimeh/go-midjourney"
```
## Documentation
Please see the
[Go Reference](https://pkg.go.dev/github.com/jimeh/go-midjourney#section-documentation)
for documentation and examples.
## License
[MIT](https://github.com/jimeh/go-midjourney/blob/main/LICENSE)