Skip to content

Commit 9b62416

Browse files
CopilotKSemenenko
andcommitted
Improve README documentation with placeholders and clarifications
Co-authored-by: KSemenenko <4385716+KSemenenko@users.noreply.github.com>
1 parent d956f04 commit 9b62416

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ ProjectTemplate/
4646

4747
2. Clone the repository:
4848
```bash
49-
git clone https://github.com/managedcode/ProjectTemplate.git
50-
cd ProjectTemplate
49+
git clone https://github.com/your-username/your-repository.git
50+
cd your-repository
5151
```
5252

5353
3. Restore dependencies:
@@ -159,8 +159,12 @@ Update this version to release new versions to NuGet.
159159

160160
To enable the full CI/CD pipeline, configure these secrets in your GitHub repository:
161161

162-
- `NUGET_API_KEY` - API key for publishing to NuGet.org
163-
- `CODECOV_TOKEN` - Token for uploading coverage to Codecov (optional)
162+
> **Note:** These secrets are only required if you want to publish NuGet packages or track code coverage. The CI workflow will work without them for development and testing purposes.
163+
164+
- `NUGET_API_KEY` - API key for publishing to NuGet.org (required only for publishing packages)
165+
- Get your API key from [NuGet.org](https://www.nuget.org/account/apikeys)
166+
- `CODECOV_TOKEN` - Token for uploading coverage to Codecov (optional, for coverage tracking)
167+
- Get your token from [Codecov](https://codecov.io/) after connecting your repository
164168

165169
## Technologies
166170

0 commit comments

Comments
 (0)