Merge pull request #5 from encryption4all/standardize-readme

docs: standardize README

Author: rubenhensen

README.md

@@ -1,21 +1,45 @@
-# pg-components
+# <p align="center"><img src="./img/pg_logo.svg" height="128px" alt="PostGuard" /></p>
 
-PostGuard UI component library.
+> For full documentation, visit [docs.postguard.eu](https://docs.postguard.eu/repos/pg-components).
 
-## Packaging
+Reusable Svelte UI component library for PostGuard applications, published as `@e4a/pg-components` on npm. Contains shared components like file pickers, progress indicators, and authentication dialogs used by the PostGuard website.
 
-package the library
+## Development
 
-```bash
+Start the dev server:
+
+```sh
+yarn dev
+```
+
+Build the package:
+
+```sh
 yarn build
 ```
 
-## Developing
+Run type checking:
 
-develop on a custom webpage (see `src/routes/index.svelte` )
+```sh
+yarn check
+```
 
-```bash
-yarn dev
+Run linting:
+
+```sh
+yarn lint
+```
+
+Component stories (via Histoire):
+
+```sh
+yarn story:dev
 ```
 
-see `package.json` for more commands.
+## Releasing
+
+New versions are published manually to npm. Bump the version in `package.json`, commit, and run `yarn build && npm publish`.
+
+## License
+
+MIT