Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maxpou committed Mar 3, 2018
1 parent d9f3d3a commit 2379715
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 23 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ A Vue.js **Progressive Web App (PWA)** based on GitHub API.

*icon on desktop, splash screen and screen shot taken from this application*

A demo is available here: [https://gitvub.azurewebsites.net](https://gitvub.azurewebsites.net/).

## What's inside?

* [Vue.js](https://vuejs.org/): an awesome JS Framework
Expand All @@ -23,7 +25,7 @@ A Vue.js **Progressive Web App (PWA)** based on GitHub API.

... using the [GitHub Api](https://api.github.com/) ([doc](https://developer.github.com/v3)).

Based on [vue/webpack template](https://github.com/vuejs-templates/webpack) and follow [his file structure](http://vuejs-templates.github.io/webpack/structure.html).
Based on [vue-cli 3](https://github.com/vuejs/vue-cli/blob/dev/docs/README.md#conventions) and follow his file structure/conventions.


## Notes
Expand Down Expand Up @@ -80,9 +82,6 @@ npm run serve
# build for production with minification
npm run build

# build for production and view the bundle analyzer report
npm run build --report

# Run tests
npm test

Expand Down
31 changes: 12 additions & 19 deletions src/views/About.vue
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,27 @@
<blockquote>GitVub = Git + Vue.js</blockquote>
<ul>
<li>
<a href="https://vuejs.org/">VueJs 2</a>: an awesome JS Framework
</li>
<a href="https://vuejs.org/" rel="nofollow">Vue.js</a>: an awesome JS Framework</li>
<li>
<a href="https://vuex.vuejs.org/en/">Vuex</a>: A state management library for VueJs
</li>
<a href="https://vuex.vuejs.org/en/" rel="nofollow">Vuex</a>: A state management library for VueJs</li>
<li>
<a href="https://router.vuejs.org/en/">vue-router 2</a>: a routing library
</li>
<a href="https://router.vuejs.org/en/" rel="nofollow">vue-router</a>: a routing library</li>
<li>
<a href="https://github.com/mzabriskie/axios">Axios</a>: a well known library for XMLHttpRequests
</li>
<a href="https://github.com/mzabriskie/axios">Axios</a>: a well known library for XMLHttpRequests</li>
<li>
<a href="https://facebook.github.io/jest/">Facebook/Jest</a>: a test library
</li>
<a href="https://facebook.github.io/jest/" rel="nofollow">Facebook/Jest</a>: a test library</li>
<li>
<a href="https://getmdl.io/">Material Design Lite</a>: CSS Framework
</li>
<a href="https://getmdl.io/" rel="nofollow">Material Design Lite</a>: CSS Framework</li>
<li>
<a href="https://material.io/icons/">Material Icons</a>: a set of icons
</li>
<a href="https://material.io/icons/" rel="nofollow">Material Icons</a>: a set of icons</li>
<li>
<a href="https://developers.google.com/web/tools/workbox/next/" rel="nofollow">Workbox (v3)</a>: JavaScript libraries for Progressive Web Apps (PWA)</li>
</ul>
<p> using the
<p>... using the
<a href="https://api.github.com/">GitHub Api</a> (
<a href="https://developer.github.com/v3">doc</a>).
</p>
<a href="https://developer.github.com/v3">doc</a>).</p>
<p>Based on
<a href="https://github.com/vuejs-templates/webpack">vue/webpack template</a> and follow
<a href="http://vuejs-templates.github.io/webpack/structure.html">his file structure</a>.
<a href="https://github.com/vuejs/vue-cli/blob/dev/docs/README.md#conventions">vue-cli 3</a> and follow his file structure/conventions.
</p>
</div>
</div>
Expand Down

0 comments on commit 2379715

Please sign in to comment.