Skip to content

Commit cabb16c

Browse files
committed
docs: add .NET to main README.md
Tidied up .NET README to be consistent with the others
1 parent b5edc4d commit cabb16c

File tree

4 files changed

+17
-8
lines changed

4 files changed

+17
-8
lines changed

.github/MAINTAINERS.md

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ This will output a new key, associated with your email address to /tmp/new-ssh-k
2525
3. Add the public key portion to the "Deploy Keys" section in the mirror e.g. https://github.com/readmeio/metrics-sdks-node/settings/keys/new. Make sure you check "Allow write access" so it can push new code.
2626
4. Add the private key portion to the "Actions secrets" section of the monorepo: https://github.com/readmeio/metrics-sdks/settings/secrets/actions/new
2727
5. Update `./bin/split.sh` and `./.github/workflows/split-monorepo.yml` to include the new mirror and SSH key.
28+
6. Update the main README.md to include information about the new package.
2829

2930
### Issuing a new release
3031
#### Node

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ This is the monorepo for the following [ReadMe Metrics](https://readme.com/metri
88
| PHP (Laravel) | [readme/metrics](https://github.com/readmeio/metrics-sdks/tree/main/packages/php) | [![](https://img.shields.io/packagist/v/readme/metrics)](https://packagist.org/packages/readme/metrics) |
99
| Python (WSGI) | [readme-metrics](https://github.com/readmeio/metrics-sdks/tree/main/packages/python) | [![](https://img.shields.io/pypi/v/readme-metrics)](https://pypi.org/project/readme-metrics/) |
1010
| Ruby (Rails/Rack) | [readme-metrics](https://github.com/readmeio/metrics-sdks/tree/main/packages/ruby) | [![](https://img.shields.io/gem/v/readme-metrics)](https://rubygems.org/gems/readme-metrics) |
11+
| .NET | [ReadMe.Metrics](https://github.com/readmeio/metrics-sdks/tree/main/packages/dotnet) | [![](https://img.shields.io/nuget/v/ReadMe.Metrics)](https://www.nuget.org/packages/ReadMe.Metrics/) |
1112

1213
Want to build your own SDK for Developer Metrics? [Check out our guide.](https://docs.readme.com/metrics/docs/building-api-metrics-middleware)

packages/dotnet/README.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
1-
# ReadMe .NET
1+
# ReadMe.Metrics
2+
3+
[![](https://d3vv6lp55qjaqc.cloudfront.net/items/1M3C3j0I0s0j3T362344/Untitled-2.png)](https://readme.io)
4+
5+
[![npm](https://img.shields.io/nuget/v/ReadMe.Metrics.svg)](https://www.nuget.org/packages/ReadMe.Metrics/) [![Build](https://github.com/readmeio/metrics-sdks/workflows/dotnet/badge.svg)](https://github.com/readmeio/metrics-sdks)
26

37
## Contents
4-
- [Overview](#overview)
5-
- [ASP.NET Core Integration](#aspnet-core-integration)
6-
- [ASP.NET Core Middleware Reference](#aspnet-core-middleware-reference)
8+
- [ReadMe.Metrics](#readmemetrics)
9+
- [Contents](#contents)
10+
- [Overview](#overview)
11+
- [ASP.NET Core Integration](#aspnet-core-integration)
12+
- [ASP.NET Core Middleware Reference](#aspnet-core-middleware-reference)
13+
- [Group Object](#group-object)
14+
- [ReadMe Object in appsettings.json](#readme-object-in-appsettingsjson)
15+
- [Options Object](#options-object)
16+
- [Documentation URL](#documentation-url)
17+
- [Troubleshooting](#troubleshooting)
718

819
## Overview
920
With ReadMe's Metrics API your team can get deep insights into your API's usage. If you're a developer, it's super easy to send your API logs to ReadMe, Here's an overview of how the integration works:

packages/node/README.md

-4
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,8 @@
55
> 🚧 Any Issues?
66
> Integrations can be tricky! [Contact support](https://docs.readme.com/guides/docs/contact-support) if you have any questions/issues.
77
8-
9-
108
[![npm](https://img.shields.io/npm/v/readmeio.svg)](https://npm.im/readmeio) [![Build](https://github.com/readmeio/metrics-sdks/workflows/nodejs/badge.svg)](https://github.com/readmeio/metrics-sdks)
119

12-
13-
1410
## Contents
1511

1612
- [Overview](#overview)

0 commit comments

Comments
 (0)