diff --git a/package.json b/package.json index 9961b28..56f89bd 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vue-start-kit", - "version": "1.2.0", + "version": "1.2.1", "description": "", "main": "dist/index.js", "scripts": { diff --git a/readme.md b/readme.md index 60d33b1..bab6be6 100644 --- a/readme.md +++ b/readme.md @@ -1,19 +1,31 @@ # Vue Start Kit, by Abtz Labs - - + License: MIT + - - + Chat on Gitter + +
+ + + GitHub commit activity + + + Latest Release + + + Open Issues -Just another boring starter kit for Vue applications made with interesting libraries such as [Vuex](https://vuex.vuejs.org/), [Vue-Router](https://router.vuejs.org/), [ParcelJS](https://parceljs.org) (package bundler), [PugJS](https://pugjs.org), [TypeScrit](https://www.typescriptlang.org/), [Eva-Icons](https://akveo.github.io/eva-icons/) and [Seed-CSS](http://abtzlabs.github.io/seed-css/)! +
+ +Just another boring starter kit for Vue applications made with interesting libraries such as [Vuex](https://vuex.vuejs.org/), [Vue-Router](https://router.vuejs.org/), [ParcelJS](https://parceljs.org) (package bundler), [PugJS](https://pugjs.org), [TypeScrit](https://www.typescriptlang.org/), [Eva-Icons](https://akveo.github.io/eva-icons/) and [Seed-CSS](http://abtzlabs.github.io/seed-css/) (lightweight CSS boilerplate)! Found a bug? [Open an Issue](https://github.com/AbtzLabs/vue-start-kit/issues) or [Submit a pull request](https://github.com/AbtzLabs/vue-start-kit/pulls). ## What you get using this? -- 🚀 Suuuper fast app +- 🚀 Suuuuuper fast app - 🙌 Very clean and simple file structure - 🔥 Live programing environment (with Hot Module Replacement) - 🎯 Functional programing concepts @@ -40,9 +52,13 @@ From now, everything you change on the source-code will trigger an imediate upda ## Contributing -Contributions are very welcome and should be made through [pull requests](https://github.com/AbtzLabs/vue-start-kit/pulls). I did not prepare any contribution guidelines so far (sorry), so, please don't be evil. 😉 +Contributions are very welcome and are expected to be made through [pull requests](https://github.com/AbtzLabs/vue-start-kit/pulls). As for now, I don't have any contribution guidelines in place, so, please don't be evil. 😉 You can simply start by: + +1. Forking this repository; +2. Change and implement what you think necessary; +3. Submit your pull-request. -To start coding, run this in a terminal window. +Before start coding, run this in a terminal window from inside the project directory. ```sh $ npm start @@ -58,7 +74,7 @@ $ npm test ## Building for production -Run the following command on a terminal window, naturally when inside your project folder: +Run the following command on a terminal window, naturally when inside your project folder. All the outputs (the distribution package) will be placed in the `/dist` folder. ```sh $ npm run build @@ -77,11 +93,18 @@ The above copyright notice and this permission notice shall be included in all c THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +## People (teams or projects) using it + + + RepoTenshoku Team + +Wanna see your logo here? [Get in touch](https://gitter.im/AbtzLabs/vue-start-kit). + ## Be a Sponsor I can't just write about how this project can boost the start of your projects in VueJS or about how much it costs to me (time and money-wise) to build an open-source tool available to everyone. But I can trully tell you that I do this with all the love from the bottom of my heart and all the good wishes to help other developers (just like myself) which can eventually become real costs and sacrifices. If you want to kick in to help me cover _those costs_, that would be awesome! -☕️ [Buy me a coffee](https://paypal.me/abtzlabs) (I just love it)
+☕️ [Pay me a coffee](https://paypal.me/abtzlabs) (I just love it)
😉 Sponsors/ contributors, I promisse your name (and picture/ logo) will be in this page.