Skip to content

docs: add README for internal package directory #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryuichi1208 merged 1 commit into from
Jun 24, 2025
Merged

docs: add README for internal package directory #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions internal/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Internal Package

This directory contains the internal implementation packages for gorl (Go Rate Limiter).

## Structure

- `config/` - Configuration management for the rate limiter
- `limiter/` - Core rate limiting implementation
- `stats/` - Statistics collection and reporting
- `tester/` - Testing utilities and load testing tools

## Usage

These packages are internal to the gorl application and should not be imported by external packages.