@cosmicds/vue-toolkit 0.1.4 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/dist/index.common.js +236 -152
- package/dist/index.common.js.map +1 -1
- package/dist/index.umd.js +239 -155
- package/dist/index.umd.js.map +1 -1
- package/dist/index.umd.min.js +3 -3
- package/dist/index.umd.min.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Cosmic Data Stories Vue toolkit
|
|
2
|
+
|
|
3
|
+
This repository contains the basic components for constructing a Vue-based Cosmic Data Story using WorldWide Telescope. Included are a base data story component that integrates WorldWide Telescope, as well as several other general-purpose components that can be easily added to a data story.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
To install, simply run one of the following commands:
|
|
8
|
+
```
|
|
9
|
+
# If you're using NPM
|
|
10
|
+
npm i @cosmicds/vue-toolkit
|
|
11
|
+
|
|
12
|
+
# or if you're using Yarn
|
|
13
|
+
yarn add @cosmicds/vue-toolkit
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Development
|
|
17
|
+
|
|
18
|
+
If you're doing development work on these components, it will likely be useful to have an external sample project that imports a development version of this one. The easiest way to do this is probably to use [`npm-link`](https://docs.npmjs.com/cli/v10/commands/npm-link). For example:
|
|
19
|
+
```
|
|
20
|
+
cd <path-where-you-keep-this-repo>
|
|
21
|
+
npm link
|
|
22
|
+
cd <path-to-your-sample-repo>
|
|
23
|
+
npm link @cosmicds/vue-toolkit
|
|
24
|
+
```
|