@26lights/orcha 0.1.0 → 0.1.1

package/README.md

@@ -2,51 +2,43 @@
 
 Activity orchestration front-end.
 
-## Recommended IDE Setup
+## Integration
 
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+Add the exported routes into your own router:
+```typescript
+import { RouteRecordRaw } from "vue-router";
 
-## Type Support for `.vue` Imports in TS
+import Templates from "@/views/Templates.vue";
+import { getTemplateRoutes } from "@26lights/orcha";
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+const baseRoute = {
+  component: Templates,
+};
 
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
-
-1. Disable the built-in TypeScript Extension
-    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
-
-## Customize configuration
-
-See [Vite Configuration Reference](https://vitejs.dev/config/).
-
-## Project Setup
-
-```sh
-npm install
-```
-
-### Compile and Hot-Reload for Development
-
-```sh
-npm run dev
+export const orchaRoutes: Array<RouteRecordRaw> = getTemplateRoutes(
+  "/templates",
+  baseRoute
+);
 ```
 
-### Type-Check, Compile and Minify for Production
-
-```sh
-npm run build
+Define a component for the template view:
+```typescript
+<template>
+  <router-view
+    :templates="templates"
+    @add-template="createTemplate"
+  />
+</template>
+<script setup lang="ts">
+import "@26lights/orcha/dist/orcha.css";
+
+const templates = []// your templates
+
+const createTemplate = async () => {
+  // Create a new template
+};
+</script>
 ```
 
-### Run Unit Tests with [Vitest](https://vitest.dev/)
-
-```sh
-npm run test:unit
-```
-
-### Lint with [ESLint](https://eslint.org/)
-
-```sh
-npm run lint
-```
+## License
+[CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)

package/package.json

@@ -4,7 +4,7 @@
   "type": "module",
   "license": "CC-BY-NC-ND-4.0",
   "author": "26lights <dev@26lights.com> (https://www.26lights.com)",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "workspaces": [
     "packages/*"
   ],