summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-06-24 10:00:28 +0300
committerPaul Buetow <paul@buetow.org>2025-06-24 10:00:28 +0300
commitaf8ab19f5def6f00081b0a6d1e5b20b76683f720 (patch)
tree89ab045f8da4af0bb6af8b26e7851e7bddfad6e7 /README.md
parent577d3d37a47dc7279d7e56975448aa330d6b5469 (diff)
refactor: use value semantics for GitHub and Codeberg clients
- Changed github.NewClient() to return Client instead of *Client - Changed codeberg.NewClient() to return Client instead of *Client - Updated sync_handlers.go to handle value semantics properly - Both clients only contain immutable string fields, making value semantics more appropriate docs: add comprehensive documentation - Added doc/ directory with full documentation - Created architecture overview explaining system design - Added complete API reference for all packages, types, and functions - Created configuration guide with examples - Added usage examples and common workflows - Created development guide for contributors - Updated README with links to documentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2cb27e9..b44ef36 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,16 @@
GitSyncer is a tool for synchronizing git repositories between multiple organizations (e.g., GitHub and Codeberg). It automatically keeps all branches in sync across different git hosting platforms.
+## Documentation
+
+📚 **[Full documentation is available in the doc/ directory](doc/README.md)**
+
+- [Architecture Overview](doc/architecture.md) - System design and components
+- [API Reference](doc/api-reference.md) - Complete reference of all packages and functions
+- [Configuration Guide](doc/configuration.md) - Detailed configuration options
+- [Usage Examples](doc/examples.md) - Common usage patterns and workflows
+- [Development Guide](doc/development.md) - Contributing and development setup
+
## Features
- Sync repositories between multiple git organizations
@@ -157,4 +167,4 @@ Excluded branches will be reported during sync but not synchronized.
## License
-[Add your license here] \ No newline at end of file
+BSD 2-Clause License. See [LICENSE](LICENSE) file for details. \ No newline at end of file