Skip to content

Commit 2e1bc33

Browse files
authored
feat: migrating the repository over to a monorepo structure (#5)
* feat: migrating the repository over to a monorepo structure * ci: adding a pull request template * docs: shuffling the readmes around
1 parent 8a61a99 commit 2e1bc33

37 files changed

+8839
-3015
lines changed

.eslintignore

-2
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## 🧰 What's being changed?
2+
3+
Describe in detail what this PR is for.
4+
5+
## 🧪 Testing
6+
7+
Provide as much information as you can on how to test what you've done.

.gitignore

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
node_modules
2-
coverage
3-
.nyc_output
1+
node_modules/
2+
packages/*/node_modules/
3+
packages/*/coverage/

.prettierignore

-1
This file was deleted.

README.md

+3-42
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,5 @@
1-
# readmeio
1+
[![](https://d3vv6lp55qjaqc.cloudfront.net/items/1M3C3j0I0s0j3T362344/Untitled-2.png)](https://readme.com)
22

3-
Track your API metrics within ReadMe.
3+
This is the monorepo for the following [ReadMe Metrics](https://readme.com/metrics/) SDKs:
44

5-
[![Build](https://github.com/readmeio/readme-node/workflows/Node%20CI/badge.svg)](https://github.com/readmeio/readme-node)
6-
7-
[![](https://d3vv6lp55qjaqc.cloudfront.net/items/1M3C3j0I0s0j3T362344/Untitled-2.png)](https://readme.io)
8-
9-
## Installation
10-
11-
```
12-
npm install readmeio
13-
```
14-
15-
## Usage
16-
17-
Just add the middleware to express, and that's it!
18-
19-
```javascript
20-
const readme = require('readmeio');
21-
22-
app.use(readme.metrics('<<apiKey>>', req => ({
23-
id: req.project._id,
24-
label: req.project.name,
25-
email: req.project.owner
26-
})));
27-
```
28-
29-
View full documentation here: [https://docs.readme.com/docs/sending-logs-to-readme-with-nodejs](https://docs.readme.com/docs/sending-logs-to-readme-with-nodejs)
30-
31-
32-
### Limitations
33-
- Currently only supports JSON request bodies. Adding a whitelist/blacklist for non-JSON bodies will not work (unless they're added to `req.body`) the same way that `body-parser` does it. The properties will be passed into [`postData`](http://www.softwareishard.com/blog/har-12-spec/#postData) as a `params` array.
34-
- Needs more support for getting URLs when behind a reverse proxy: `x-forwarded-for`, `x-forwarded-proto`, etc.
35-
- Needs more support for getting client IP address when behind a reverse proxy.
36-
- Logs are "fire and forget" to the metrics server, so any failed requests (even for incorrect API key!) will currently fail silently.
37-
38-
## Credits
39-
[Dom Harrington](https://github.com/domharrington/)
40-
[Marc Cuva](https://github.com/mjcuva/)
41-
42-
## License
43-
44-
ISC
5+
* [readmeio](https://github.com/readmeio/metrics-sdks/tree/master/node) (NodeJS)

lerna.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"packages": [
3+
"packages/*"
4+
],
5+
"version": "2.1.5"
6+
}

0 commit comments

Comments
 (0)