chore: update docs

Author: igeligel

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-present all contributors listed here https://github.com/gothinkster/vue-realworld-example-app/graphs/contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

README.md

@@ -1,30 +1,62 @@
-# vue-realworld-example-app
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-> A Vue.js project
+# ![RealWorld Example App](./static/rwv-logo.png)
 
-## Build Setup
+> Vue.js codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.
+
+Project demo is available at https://vue-vuex-realworld.netlify.com/#/
+
+This codebase was created to demonstrate a fully fledged fullstack application built with **Vue.js** including CRUD operations, authentication, routing, pagination, and more.
+
+We've gone to great lengths to adhere to the **Vue.js** community styleguides & best practices.
+
+For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.
+
+## Getting started
+
+Before contributing please read the following:
+
+1. [RealWorld guidelines](https://github.com/gothinkster/realworld/tree/master/spec) for implementing a new framework,
+2. [RealWorld frontend instructions](https://github.com/gothinkster/realworld-starter-kit/blob/master/FRONTEND_INSTRUCTIONS.md)
+3. [Realworld API endpoints](https://github.com/gothinkster/realworld/tree/master/api)
+4. [Vue.js styleguide](https://vuejs.org/v2/style-guide/index.html). Priority A and B categories must be respected.
+
+The stack is built using [vue-cli webpack](https://github.com/vuejs-templates/webpack) so to get started all you have to do is:
 
 ``` bash
 # install dependencies
-npm install
-
+> yarn install
 # serve with hot reload at localhost:8080
-npm run dev
+> yarn run dev
+```
 
-# build for production with minification
-npm run build
+Other commands available are:
 
-# build for production and view the bundle analyzer report
-npm run build --report
+``` bash
+# build for production with minification
+yarn run build
 
 # run unit tests
-npm run unit
+yarn run unit
 
 # run e2e tests
-npm run e2e
+yarn run e2e
 
 # run all tests
-npm test
+yarn test
 ```
 
-For a detailed explanation on how things work, check out the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
+# To know
+
+Current arbitrary choices are:
+
+- Vuex modules for store
+- Vue-axios for ajax requests
+- Standard for linting
+- 'rwv' as prefix for components
+
+These can be changed when the contributors reach a consensus.
+
+# Connect
+
+Join us on [Discord](https://discord.gg/NE2jNmg)

package.json

@@ -1,9 +1,8 @@
 {
-  "name": "vue-realworld-example-app",
+  "name": "realworld-vue",
   "version": "1.0.0",
-  "description": "A Vue.js project",
-  "author": "igeligel <[email protected]>",
-  "private": true,
+  "description": "TodoMVC for the RealWorld™",
+  "author": "Emmanuel Vilsbol <[email protected]>",
   "scripts": {
     "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
     "start": "npm run dev",