Skip to content

Commit 7f3ef25

Browse files
committed
Update README.md
1 parent 07ad691 commit 7f3ef25

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,22 @@
33
[![npm package](https://img.shields.io/npm/v/posthog-plugin-hello-world?style=flat-square)](https://www.npmjs.com/package/posthog-plugin-hello-world)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)
55

6-
This is an exemplary PostHog plugin. It adds property `"greeting"` to every event with a configurable value `"Hello world!"` by default.
6+
This is an exemplary PostHog plugin. It adds property `"greeting"` to every event, with a configurable value (by default: `"Hello world!"`).
77

8-
A few goodies included with this plugin:
9-
- TypeScript for best reliability and development experience,
10-
- Jest for convenient testing,
11-
- Prettier and ESLint for code style and best practices – both handled by pre-commit hooks,
12-
- GitHub Actions set up to run code quality and functionality tests in pull requests, and also to publish a new npm release when the package version is incremented in `main` (the latter requires an automation type npm access token to be set with a repo secret `NPM_TOKEN`).
8+
Feel free to use it as a base for your own plugins!
9+
10+
## Goodies included
11+
12+
- TypeScript for best reliability and development experience
13+
- Jest for convenient testing
14+
- Prettier and ESLint for code style and best practices – both handled by pre-commit hooks
15+
- GitHub Actions set up to run code quality and functionality tests in pull requests, and also to publish a new npm release when the package version is incremented in `main` (the latter requires an automation type npm access token to be set with a repo secret `NPM_TOKEN`)
16+
17+
## Installation
18+
19+
1. Open PostHog.
20+
1. Head to the Plugins page from the sidebar.
21+
1. Either install Hello World from Available plugins, or install from URL using this repository's URL.
1322

1423
## Questions?
1524

0 commit comments

Comments
 (0)