Skip to content

Commit

Permalink
docs: some quick documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sinkaroid committed Apr 12, 2023
1 parent 667e283 commit 3872394
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,31 @@
# Features
<div align="center">

<img src="https://scathachbot.xyz/img/about/logo-ngeri.png" alt="Logo" width="250px" height="250px" style="border-radius:10%"/>

# @ScathachGrip/gaebolg

**Prototype API design with only cloudflare workers and lambda functions**

[![eslint-check](https://github.com/ScathachGrip/gaebolg/actions/workflows/build.yml/badge.svg)](https://github.com/ScathachGrip/gaebolg/actions/workflows/build.yml)
[![Maintainability](https://api.codeclimate.com/v1/badges/76bf88b037eba8ddcd6c/maintainability)](https://codeclimate.com/github/ScathachGrip/gaebolg/maintainability)

</div>

## Features
- Serverless
- Reverse image proxy
- Ratelimiting
- Ratelimiting & throttling
- GitLab Pages unlimited storage
- Redis cluster support

# Information
## Information
- [Cloudflare Workers](https://workers.cloudflare.com/)
- [Lambda Functions](https://www.netlify.com/products/functions/)
- [Documentation](https://scathachgrip.github.io/gaebolg/)
- [Documentation](https://scathachgrip.github.io/gaebolg/)

Fully operational in production by [Scathach Bot](https://scathachbot.xyz)

## Legal
This tool can be freely copied, modified, altered, distributed without any attribution whatsoever. However, if you feel
like this tool deserves an attribution, mention it. It won't hurt anybody.
> Licence: WTF.

0 comments on commit 3872394

Please sign in to comment.