From 1073db29bb16578c8ff176589eecc5be7e9701fd Mon Sep 17 00:00:00 2001 From: ryuichi1208 Date: Tue, 24 Jun 2025 19:29:16 +0900 Subject: [PATCH] docs: add README for internal package directory MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add documentation explaining the purpose and structure of the internal package directory to improve code organization clarity. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- internal/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 internal/README.md diff --git a/internal/README.md b/internal/README.md new file mode 100644 index 0000000..de08343 --- /dev/null +++ b/internal/README.md @@ -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. \ No newline at end of file