From 8d8d8730cf7e13c7df1cb8f81beebcd714b7ccd1 Mon Sep 17 00:00:00 2001 From: Sipke Schoorstra Date: Mon, 27 Mar 2023 20:58:10 +0200 Subject: [PATCH] Update designer readme --- .../elsa-workflows-designer/readme.md | 74 +------------------ 1 file changed, 1 insertion(+), 73 deletions(-) diff --git a/src/designer/designer_packages/elsa-workflows-designer/readme.md b/src/designer/designer_packages/elsa-workflows-designer/readme.md index 3db484fb0..9a6835de5 100644 --- a/src/designer/designer_packages/elsa-workflows-designer/readme.md +++ b/src/designer/designer_packages/elsa-workflows-designer/readme.md @@ -1,75 +1,3 @@ ![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square) -# Stencil Component Starter - -This is a starter project for building a standalone Web Component using Stencil. - -Stencil is also great for building entire apps. For that, use the [stencil-app-starter](https://github.com/ionic-team/stencil-app-starter) instead. - -# Stencil - -Stencil is a compiler for building fast web apps using Web Components. - -Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec. - -Stencil components are just Web Components, so they work in any major framework or with no framework at all. - -## Getting Started - -To start building a new web component using Stencil, clone this repo to a new directory: - -```bash -git clone https://github.com/ionic-team/stencil-component-starter.git my-component -cd my-component -git remote rm origin -``` - -and run: - -```bash -npm install -npm start -``` - -To build the component for production, run: - -```bash -npm run build -``` - -To run the unit tests for the components, run: - -```bash -npm test -``` - -Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component). - - -## Naming Components - -When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: ``). This is because the generated component has little to nothing to do with Stencil; it's just a web component! - -Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix `ion`. - - -## Using this component - -There are three strategies we recommend for using web components built with Stencil. - -The first step for all three of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages). - -### Script tag - -- Put a script tag similar to this `` in the head of your index.html -- Then you can use the element anywhere in your template, JSX, html etc - -### Node Modules -- Run `npm install my-component --save` -- Put a script tag similar to this `` in the head of your index.html -- Then you can use the element anywhere in your template, JSX, html etc - -### In a stencil-starter app -- Run `npm install my-component --save` -- Add an import to the npm packages `import my-component;` -- Then you can use the element anywhere in your template, JSX, html etc +# Elsa Workflows Designer