From 43e18770e72797bbd2fc2c710f319397eee11062 Mon Sep 17 00:00:00 2001 From: Nshen Date: Wed, 3 Mar 2021 17:25:30 +0800 Subject: [PATCH] add README.md --- README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6865043 --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ +# vite-plugin-cesium + +[![npm](https://img.shields.io/npm/v/vite-plugin-cesium.svg)](https://www.npmjs.com/package/vite-plugin-cesium) + +Easily set up a [`Cesium`] project in [`Vite`]. + +[`Cesium`]: https://github.com/CesiumGS/cesium +[`Vite`]: https://github.com/vitejs/vite + +## Install + +```bash +npm i cesium -D # yarn add cesium -D +npm i vite-plugin-cesium -D # yarn add vite-plugin-cesium -D +``` + +## Usage + +add this plugin to `vite.config.js` + +```js +import { defineConfig } from 'vite'; +import cesium from 'vite-plugin-cesium'; +export default defineConfig({ + plugins: [cesium()], +}); +``` + +## Demo + + +`src/index.js` + +```js +import { Viewer } from 'cesium'; +import "./css/main.css"; + +const viewer = new Viewer('cesiumContainer'); +``` + +`index.html` + +```html + + + + + + + + cesium-vite + + + + +
+ + + +``` + +`src/css/main.css` + +```css +html, body, #cesiumContainer { + width: 100%; + height: 100%; + margin: 0; + padding: 0; + overflow: hidden; +} +``` + +Add `dev` and `build` commands to `package.json` + +``` +"scripts": { + "dev": "vite", + "build": "vite build" +}, +``` +Run `yarn dev` + +For full demo project please check [./demo](https://github.com/nshen/vite-plugin-cesium/tree/main/demo) folder. + +## License + +MIT \ No newline at end of file