Skip to content

Commit

Permalink
stylish readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Karitham committed Jan 4, 2022
1 parent f9e70f6 commit 4758e20
Showing 1 changed file with 26 additions and 10 deletions.
36 changes: 26 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
# corde
#

<span align="center">

```txt
_
| |
___ ___ _ __ __| | ___
/ __| / _ \ | '__| / _` | / _ \
| (__ | (_) || | | (_| || __/
\___| \___/ |_| \__,_| \___|
```

</span>

<span align="center">

[![report card](https://goreportcard.com/badge/github.com/Karitham/corde)](https://goreportcard.com/report/github.com/Karitham/corde)
[![badge](https://pkg.go.dev/badge/github.com/Karitham/corde)](https://pkg.go.dev/github.com/Karitham/corde)

</span>

---

corde is a discord webhook callback API wrapper. It aims to have an high level API to simplify the user's life as much as possible.
Expand All @@ -15,6 +33,12 @@ All those don't hinder the fact that you can use corde with as much control as y

Be aware that breaking changes will happen as of now, at least until v1.

## Install

```sh
go get github.com/Karitham/corde
```

## Examples

The most basic one is [**bongo**](_example/bongo/main.go)
Expand All @@ -26,12 +50,6 @@ It demonstrates the usage of components such as buttons.

Corde is also actively used to rewrite and develop another discord bot of mine called [**WaifuBot**](https://github.com/Karitham/WaifuBot/) (for now see the corde branch)

## Install

```sh
go get github.com/Karitham/corde
```

## Why

Having used most go discord libs available, I wanted something very lightweight yet high-level, that could just run on a lambda without state, caching or long start-up times.
Expand All @@ -40,6 +58,4 @@ Corde has a single dependency as of yet, and it's just a codegen utility.

The common libs out there didn't really fit that purpose, and neither did they implement the webhook callback API available.

It's from that usecase that corde is born.

Corde means *rope* in french, because discord's API inspires exactly that /s
Corde means *rope* in french, because discord's API inspires exactly that */s*

0 comments on commit 4758e20

Please sign in to comment.