Updated README.md

README.md

@@ -1,3 +1,36 @@
-# Internal Scriptor API
+<div align="center">
+    <img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-scriptor.svg" height="196" alt="A hexagonal logo of Scriptor" title="Scriptor logo">
+    <h1>viur-scriptor-api</h1>
+    <!--
+    <a href="https://github.com/viur-framework/viur-scriptor/actions/workflows/test.yml">
+        <img src="https://github.com/viur-framework/viur-scriptor/actions/workflows/test.yml/badge.svg" alt="Badge displaying the test status" title="Test badge">
+    </a>
+    -->
+    <a href="https://github.com/viur-framework/viur-scriptor/LICENSE">
+        <img src="https://img.shields.io/github/license/viur-framework/viur-scriptor-api" alt="Badge displaying the license" title="License badge">
+    </a>
+    <br>
+    Universal Python API for scripting and interacting with ViUR.
+</div>
+
+## About
 
 This is the official Scriptor API, which is used by the viur-scriptor in both the web version and the terminal version.
+
+## Usage
+
+Implements the `viur.scriptor`-namespace.
+
+You can use it either in the Pyodide-based scriptor as well as in native Python using `from viur.scriptor import ...`.
+
+## Documentation
+
+ReadTheDocs link follows soon, a gread documentation is already available in the source code!
+
+## License
+
+Copyright © 2024 by Mausbrand Informationssysteme GmbH.<br>
+Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.
+
+Logics is free software under the MIT license.<br>
+Please see the LICENSE file for details.