initial

README.md

@@ -0,0 +1,36 @@
+# albert-uuid-gen
+
+Extension for generating version 4 [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)s in [Albert launcher](https://albertlauncher.github.io/).
+
+## Installation
+
+1. Locate the `modules` directory in the Python extension data directory.
+
+The data directories reside in the data directories of the application defined by Qt.
+
+```
+~/.local/share/albert/python/plugins
+```
+
+2. Clone this repository into your `modules` directory.
+
+```bash
+cd /path/to/modules
+
+git clone git@gitea.felix-boers.de:fboers/albert-uuid-generator.git
+```
+
+3. Enable the extension in the settings under `Extensions`.
+
+## Usage
+
+Generates a version 4 UUID.
+
+Synopsis: `<trigger>`
+
+Example: 
+- `uuid`: generate a random UUID and copy to the clipboard.
+
+## Contributing
+
+If you have any questions, suggestions, or issues, please feel free to open an issue or pull request.