Comparing version 0.3.0 to 0.3.1
{ | ||
"name": "skewed", | ||
"version": "0.3.0", | ||
"version": "0.3.1", | ||
"description": "Generate 3D isometric SVGs", | ||
@@ -5,0 +5,0 @@ "author": "Francois Laberge", |
# Skewed | ||
Skewed is a Typescript package for generating SVG of 3D graphics in real-time or offline files. | ||
Skewed is a Typescript package for generating SVG of 3D graphics in real-time. It has an opionated default look and orthographic projection only camera support, isometric by default. | ||
Use it to make simple 3D infographics, 3D web-games, or generate 3D SVG files for importing into vector editors like Figma/Illustrator (Ie. make 3D icons). | ||
Use it to make simple 3D infographics, 3D web-games, or generate 3D SVG files for importing into vector editors like Figma/Illustrator (Ie. make 3D icons). | ||
- Camera Projections | ||
- Isometric | ||
- Built in shapes: | ||
- Box | ||
- Cylinder | ||
[Live demo](https://vgyf3c.csb.app/) | ||
<img width="50%" src="./docs/images/isometric.png" style="margin: 0px 25%"/> | ||
<img width="100%" src="./docs/images/skewed-screen-capture.gif"/> | ||
# Usage | ||
```sh | ||
npm install skewed | ||
``` | ||
1. `npm install skewed` | ||
1. Reference the [live demo](https://vgyf3c.csb.app/)'s [source code](https://codesandbox.io/s/skewed-demo-vgyf3c?file=/src/index.ts). More API examples coming soon. In the meantime | ||
**Coordinate System** | ||
<img width="256" src="./docs/images/coordinate-system.png"/> | ||
```ts | ||
// TBD | ||
``` | ||
## Contributing | ||
@@ -43,3 +31,5 @@ | ||
#### Dev | ||
To serve up the workbench web-page and rebuild on code changes run the following. | ||
``` | ||
@@ -65,2 +55,4 @@ pnpm dev | ||
``` | ||
# Make sure tests pass. `pnpm test` (we should automate this in a publish command) | ||
pnpm build | ||
npm version <major|minor|patch> | ||
@@ -67,0 +59,0 @@ git push; git push --tags |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
51835
0
102