initial commit

add project scope
add features goals

Author: 1pkg

.gitignore

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Kostiantyn Masliuk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -0,0 +1,16 @@
+# Gohalt 🛑: Deadly Fast and Incredebly Powerful Solution for Throttling and Rate Limiting
+
+## Features
+
+- Blastly fast and effective, Gohalt has close to zero overhead for your application as it uses well known dead simple but yet powerful throttling techniques and algorithms, check benchmark section for comparison.
+- Flexible and powerful, Gohalt supports numbers of different strategies and conditions on rate limiting and throttling that could be easily adjust to your needs.
+- Easily integratable, Gohalt provides numbers of built in middlewares to have one line integrations with http, fasthttp, gin, grpc, etc.
+- Full metrics awareness, Gohalt could use metrics as main source of conditions for throttling, it does/will fully support for prometheus metrics.
+- Queueing out of the box, Gohalt supports execution queueing out of the box which means you can easily save throttled query to queue to process it later.
+- No external dependencies, Gohalt has zero additional external dependencies even for durable setups it doesn't need neither redis nor memchached nor nothing else.
+- Optional durable embedded dbadger k/v, Gohalt can be set to use embedded dbadger k/v to provide durability for reads/writes.
+
+## Licence
+
+Gopium is licensed under the MIT License.  
+See [LICENSE](LICENSE) for the full license text.