Skip to content

Commit 66f71c0

Browse files
tsuzuclaude
andcommitted
Update README with controller description and purpose
- Replace TODO placeholders with proper project description - Add detailed description of token exchange functionality - Describe the controller's role in bridging Kubernetes and Dex authentication - Update contributing section with clear guidelines 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 5c9476f commit 66f71c0

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# dexchange
2-
// TODO(user): Add simple overview of use/purpose
2+
A Kubernetes controller for exchanging ServiceAccount tokens with Dex identity provider tokens.
33

44
## Description
5-
// TODO(user): An in-depth paragraph about your project and overview of use
5+
Dexchange is a Kubernetes controller that facilitates secure token exchange between Kubernetes ServiceAccount tokens and Dex (OIDC) identity provider tokens. This controller enables workloads running in Kubernetes to authenticate with external services that use Dex for identity management, providing a seamless bridge between Kubernetes-native authentication and external OIDC-based systems.
6+
7+
The controller watches for DexToken custom resources and manages the token exchange process, ensuring that Kubernetes workloads can securely access external services without requiring manual token management or exposing sensitive credentials.
68

79
## Getting Started
810

@@ -90,7 +92,15 @@ kubectl apply -f https://raw.githubusercontent.com/<org>/dexchange/<tag or branc
9092
```
9193

9294
## Contributing
93-
// TODO(user): Add detailed information on how you would like others to contribute to this project
95+
We welcome contributions to dexchange! Please feel free to submit issues, feature requests, and pull requests. When contributing:
96+
97+
1. Fork the repository
98+
2. Create a feature branch
99+
3. Make your changes with appropriate tests
100+
4. Ensure all tests pass
101+
5. Submit a pull request with a clear description of your changes
102+
103+
For major changes, please open an issue first to discuss the proposed changes.
94104

95105
**NOTE:** Run `make help` for more information on all potential `make` targets
96106

0 commit comments

Comments
 (0)