Skip to content

Commit 61f742f

Browse files
Merge pull request #27 from chellej/patch-2
Update README.md
2 parents 174bf1a + 0c796ab commit 61f742f

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,12 @@ A self-service engineering platform, <a href="https://meshery.io">Meshery</a>, i
5959

6060
<img src="https://raw.githubusercontent.com/meshery-extensions/shape-builder/98531eecdd2c5b01895f1d818f824bf186bf6077/.github/assets/images/site.png" width="100%" align="center" />
6161

62-
Anyone can create new components. When they do, they can use a predefined shape to represent their new component. Alternatively, they can define their own polygon; their own shape. The matter in which shapes are defined is based on a number matrix from negative one to positive one.
62+
This Meshery extension offers an easy way to visually create polygons, outputting the format necessary for Kanvas to recognize and render your custom polygon shape. As a best practice, users are encouraged to select an existing or create acustom shape for their components to best visually signify the function of their component. See the [Components Shape Guide](https://docs.meshery.io/extensions/component-shape-guide) for a list of the built-in component shapes in Meshery.
6363

64-
This Meshery extension offers an easy way to visually create polygons, outputting the format necessary for Kanvas to recognize and render your custom polygon shape.
64+
Interactively, explore existing component shapes easily by looking in [Meshery Playground](https://play.meshery.io) in the Kanvas extension's on the dock at the bottom of the screen. You will see the different types of component shapes in the "Shapes" model as examples.
6565

66-
Explore existing component shapes easily by looking in Meshery Playground in the Kanvas extension's on the dock at the bottom of the screen. You will see the different types of component shapes in the "Shapes" model as examples.
66+
## Usage
6767

68-
### Usage
6968
Once you have created your custom shape, export your matrix notation and use within a `polygon` shape in your Meshery Component. For example, the following is a plus icon:
7069

7170
#### Custom Shape Example
@@ -75,6 +74,10 @@ Once you have created your custom shape, export your matrix notation and use wit
7574
-0.33 -1 0.33 -1 0.33 -0.33 1 -0.33 1 0.33 0.33 0.33 0.33 1 -0.33 1 -0.33 0.33 -1 0.33 -1 -0.33 -0.33 -0.33
7675
```
7776

77+
### Additional Details
78+
79+
Anyone can create new components. When they do, they can use a predefined shape to represent their new component. Alternatively, they can define their own polygon; their own shape. The manner in which shapes are defined is based on a number matrix from negative one to positive one.
80+
7881
<div>&nbsp;</div>
7982

8083
## Join the Meshery community!

0 commit comments

Comments
 (0)