diff --git a/README.md b/README.md index 3071d9f..c72d4d3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # G1 TypeScript Common Packages -This monorepo contains common TypeScript packages used across Generation One projects. +This monorepo contains common TypeScript packages used across Generation One projects. The repository is public, making it easier to share and collaborate on common utilities. ## Repository Structure @@ -37,6 +37,7 @@ A custom Server-Sent Events (SSE) client that supports headers and bypasses cert Clone the repository: ```bash +# No authentication required for cloning the public repository git clone https://git.generation.one/GenerationOne/g1-ts-common-packages.git cd g1-ts-common-packages ``` @@ -60,12 +61,16 @@ pnpm build Add the package to your project: ```bash +# If you're a Generation One team member using the private Gitea registry: # Configure the Gitea registry echo "@g1:registry=https://git.generation.one/api/packages/GenerationOne/npm/" > .npmrc echo "//git.generation.one/api/packages/GenerationOne/npm/:_authToken=${GITEA_TOKEN}" >> .npmrc # Install the package pnpm add @g1/sse-client + +# Alternatively, you can install directly from the public GitHub repository: +pnpm add git+https://git.generation.one/GenerationOne/g1-ts-common-packages.git#packages/sse-client ``` ### Example Usage @@ -137,7 +142,9 @@ pnpm -r test ### Prerequisites - Gitea access token with `packages:write` permission -- Access to the Generation One Gitea repository +- Write access to the Generation One Gitea repository + +> **Note:** While the repository is public and anyone can clone it, publishing packages to the Gitea registry requires proper authentication and authorization. ### Publishing a Package @@ -170,6 +177,18 @@ To use the workflows, you need to set up the following secrets in your GitHub re - `GITEA_TOKEN`: Your Gitea access token - `GITEA_DEPLOY_KEY`: SSH deploy key for the repository +## Contributing + +Since this repository is public, contributions are welcome! Here's how you can contribute: + +1. Fork the repository +2. Create a feature branch (`git checkout -b feature/amazing-feature`) +3. Commit your changes (`git commit -m 'Add some amazing feature'`) +4. Push to the branch (`git push origin feature/amazing-feature`) +5. Open a Pull Request + +Please make sure your code follows the existing style and includes appropriate tests. + ## License MIT