This repository was archived by the owner on Jan 1, 2021. It is now read-only.

Commit 8829ea8

author

krthr

committed

readme

1 parent a2b66ff commit 8829ea8Copy full SHA for 8829ea8

File tree

19 files changed

+133

-71

lines changed

.gitignore
README.md
deploy.sh
docs
- .vuepress
  - config.js
  - dist
    - 404.html
    - assets
      - css
        0.styles.ad037017.css
      - js
        2.302c0615.js
        3.5e6482c8.js
        4.e2cbf7b5.js
        5.dac4b362.js
        6.51c8b05d.js
        7.bbb089a3.js
        app.03c1f633.js
    - guide
      - index.html
    - index.html
- README.md
- api
  - README.md
- es
  - README.md
- guide
  - README.md

19 files changed

+133

-71

lines changed

`‎.gitignore‎`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`.DS_Store`
`2`	`2`	`node_modules`
`3`	`3`	`/dist`
	`4`	`+/docs/.vuepress/dist`
`4`	`5`
`5`	`6`	`# local env files`
`6`	`7`	`.env.local`

`‎README.md‎`

Lines changed: 38 additions & 19 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,29 +1,48 @@`
`1`	`1`	`# vue-dataflow-editor`
`2`	`2`
`3`		`-## Project setup`
`4`		-```
`5`		`-yarn install`
`6`		-```
	`3`	`+> Based on [vue-blocks](https://github.com/ghostiam/vue-blocks). A [@ghostiam](https://github.com/ghostiam)'s project.`
`7`	`4`
`8`		`-### Compiles and hot-reloads for development`
`9`		-```
`10`		`-yarn run serve`
`11`		-```
	`5`	`+## npm`
`12`	`6`
`13`		`-### Compiles and minifies for production`
`14`	`7`	```
`15`		`-yarn run build`
	`8`	`+npm i @krthr/vue-dataflow-editor`
`16`	`9`	```
`17`	`10`
`18`		`-### Run your tests`
`19`		-```
`20`		`-yarn run test`
	`11`	+```html
	`12`	`+<template>`
	`13`	`+ <vue-blocks-container`
	`14`	`+ class="container"`
	`15`	`+ :blocks-content="[]"`
	`16`	`+ :scene.sync="{}"`
	`17`	`+ />`
	`18`	`+</template>`
`21`	`19`	```
`22`	`20`
`23`		`-### Lints and fixes files`
`24`		-```
`25`		`-yarn run lint`
`26`		-```
	`21`	`+## browser`
	`22`	`+`
	`23`	+```html
	`24`	`+<body>`
	`25`	`+ <div id="app">`
	`26`	`+ <vue-blocks-container`
	`27`	`+ ref="container"`
	`28`	`+ :blocks-content="[]"`
	`29`	`+ :scene.sync="{}"`
	`30`	`+ class="container"`
	`31`	`+ />`
	`32`	`+ </div>`
	`33`	`+`
	`34`	`+ <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>`
	`35`	`+ <script src="https://unpkg.com/@krthr/vue-dataflow-editor@latest/dist/vue-dataflow-editor.umd.min.js"></script>`
	`36`	`+ <script>`
	`37`	`+ new Vue({`
	`38`	`+ el: "#app",`
`27`	`39`
`28`		`-### Customize configuration`
`29`		`-See [Configuration Reference](https://cli.vuejs.org/config/).`
	`40`	`+ // ...`
	`41`	`+`
	`42`	`+ components: {`
	`43`	`+ ...window["vue-dataflow-editor"].default`
	`44`	`+ }`
	`45`	`+ });`
	`46`	`+</script>`
	`47`	`+</body>`
	`48`	+```

`‎deploy.sh‎`

Lines changed: 2 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,5 @@ git add -A`
`17`	`17`	`git commit -m 'deploy'`
`18`	`18`
`19`	`19`	`# if you are deploying to https://<USERNAME>.github.io/<REPO>`
`20`		`-git push -f krthr:lilofa98@github.com/krthr/vue-dataflow-editor.git master:gh-pages`
`21`		`-`
`22`		`-cd -`
	`20`	`+git remote add origin https://github.com/krthr/vue-dataflow-editor.git`
	`21`	`+git push -f origin master:gh-pages`

`‎docs/.vuepress/config.js‎`

Lines changed: 7 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,8 @@ module.exports = {`
`4`	`4`	`themeConfig: {`
`5`	`5`	`nav: [`
`6`	`6`	`{ text: "Home", link: "/" },`
`7`		`- { text: "Guide", link: "/guide/" },`
	`7`	`+ // { text: "Guide", link: "/guide/" },`
	`8`	`+ { text: "API Reference", link: "/api/" },`
`8`	`9`	`{ text: "External", link: "https://google.com" }`
`9`	`10`	`],`
`10`	`11`
`@@ -28,11 +29,14 @@ module.exports = {`
`28`	`29`	`lang: "en-US",`
`29`	`30`	`title: "Vue Dataflow Editor",`
`30`	`31`	`description: "Vue 2 dataflow graph editor"`
`31`		`- },`
`32`		`- "/es": {`
	`32`	`+ }`
	`33`	`+`
	`34`	`+ /**`
	`35`	`+ "/es/": {`
`33`	`36`	`lang: "es-CO",`
`34`	`37`	`title: "Vue Dataflow Editor",`
`35`	`38`	`description: "Editor grafico para Vue 2"`
`36`	`39`	`}`
	`40`	`+ */`
`37`	`41`	`}`
`38`	`42`	`};`