Comparing version 0.0.1-alpha to 0.0.2-alpha
{ | ||
"name": "threeify", | ||
"version": "0.0.1-alpha", | ||
"version": "0.0.2-alpha", | ||
"description": "Typescript 3D Library", | ||
"keywords": [], | ||
"author": "Ben Houston", | ||
"author": "threeify authors", | ||
"license": "ISC", | ||
@@ -8,0 +8,0 @@ "type": "module", |
@@ -1,9 +0,23 @@ | ||
# Threeify | ||
<h1 align="center" style="border-bottom: none;">threeify</h1> | ||
<h3 align="center">A Typescript library loosely based on three.js</h3> | ||
<p align="center"> | ||
<a href="https://www.npmjs.com/package/threeify"> | ||
<img alt="npm latest version" src="https://img.shields.io/npm/v/threeify/latest.svg"> | ||
</a> | ||
<a href="https://www.npmjs.com/package/threeify"> | ||
<img alt="npm next version" src="https://img.shields.io/npm/v/threeify/next.svg"> | ||
</a> | ||
</p> | ||
A Typescript 3D Library loosely based on Three.js | ||
**threeify** is a Typescript 3D library loosely based on three.js. | ||
## Getting Started | ||
### Local | ||
To run: | ||
1. Check out the git repository | ||
1. Install node.js & npm as appropriate for your platform. | ||
2. Run npm install to install all the required node modules from package.json | ||
1. Run npm install to install all the required node modules from package.json | ||
@@ -22,10 +36,6 @@ ``` | ||
It will automatically rebuild your code on each change. | ||
### Docker Compose | ||
``` | ||
/index.html | ||
``` | ||
If you have docker and docker-compose available do: | ||
Optionally, use theia-ide to start coding immediately. If you have docker and docker-compose available do: | ||
``` | ||
@@ -35,2 +45,5 @@ docker-compose up -d | ||
theia-ide is available at http://localhost:3000. Perform step 2 and 3 in the theia-ide terminal. | ||
### Theia-IDE | ||
threeify supports the theia-ide so you can start coding immediately. theia-ide is available at http://localhost:3000. Perform step 3 and 4 in the theia-ide terminal. | ||
180098
48