Merge pull request #51 from logdash-io/chore/readme

chore: update readme with metrics

Author: szymeo

.changeset/stale-buckets-dress.md

@@ -0,0 +1,5 @@
+---
+"@logdash/js-sdk": patch
+---
+
+chore: update readme with metrics

README.md

@@ -2,22 +2,23 @@
 
 Logdash is a zero-config observability platform. This package serves an javascript interface to use it.
 
-# Pre-requisites
+## Pre-requisites
 
-Setup your free project in less than 2 minutes at [logdash.io](https://logdash.io/).
+Setup your free project in less than 2 minutes at [logdash.io](https://logdash.io/)
 
-# Installation
+## Installation
 
 ```
-npm install @logdash/core
+npm install @logdash/js-sdk
 ```
 
-# Usage
+## Logging
 
 ```typescript
-import { createLogDash } from '@logdash/core';
+import { createLogDash } from '@logdash/js-sdk';
 
 const { logger } = createLogDash({
+	// optional, but recommended to see your logs in the dashboard
 	apiKey: '<your-api-key>',
 });
 
@@ -26,27 +27,46 @@ logger.error('An unexpected error occurred');
 logger.warn('Low disk space warning');
 ```
 
-# View
+## Metrics
 
-To see the logs, go to your project dashboard
+```typescript
+import { createLogDash } from '@logdash/js-sdk';
+
+const { metrics } = createLogDash({
+	// optional, but recommended as metrics are only hosted remotely
+	apiKey: '<your-api-key>',
+});
+
+// to set absolute value
+metrics.set('users', 0);
+
+// to modify existing metric
+metrics.mutate('users', 1);
+```
+
+## View
+
+To see the logs or metrics, go to your project dashboard
 
 ![logs](docs/logs.png)
 ![delta](docs/delta.png)
 
-# Configuration
+## Configuration
 
 | Parameter | Required | Default | Description                                                                                                              |
 | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
 | `apiKey`  | no       | -       | Api key used to authorize against logdash servers. If you don't provide one, logs will be logged into local console only |
+| `host`    | no       | -       | Custom API host, useful with self-hosted instances                                                                       |
+| `verbose` | no       | -       | Useful for debugging purposes                                                                                            |
 
-# License
+## License
 
 This project is licensed under the MIT License.
 
-# Contributing
+## Contributing
 
 Contributions are welcome! Feel free to open issues or submit pull requests.
 
-# Support
+## Support
 
 If you encounter any issues, please open an issue on GitHub or let us know at [contact@logdash.io](mailto:contact@logdash.io).