Skip to content

Commit

Permalink
Design Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
jeevan15498 committed Jan 5, 2019
1 parent 6e43bb3 commit 2528a87
Show file tree
Hide file tree
Showing 10 changed files with 289 additions and 663 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [2018] [Speed Typing Tutor]

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.
46 changes: 36 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,51 @@
# Speed Typing Tutor Application
# [Speed Typing Tutor](https://speedtyping.netlify.com/#/)

https://easytyping.netlify.com
Free Online Hindi (Inscript, Kruti Dev) and English Typing Tutor

[![npm version](https://img.shields.io/badge/npm-5.6.0-blue.svg)](https://github.com/ctechhindi/Speed-Typing-Tutor)
[![electron version](https://img.shields.io/badge/electron-4.0.0-blue.svg)](https://electronjs.org)
[![Chrome version](https://img.shields.io/badge/chrome-69.0-blue.svg)](https://www.google.com/chrome)

[![GitHub stars](https://img.shields.io/github/stars/ctechhindi/Speed-Typing-Tutor.svg?style=flat-square)](https://github.com/ctechhindi/Speed-Typing-Tutor/stargazers)
[![GitHub issues](https://img.shields.io/github/issues/ctechhindi/Speed-Typing-Tutor.svg?style=flat-square)](https://github.com/ctechhindi/Speed-Typing-Tutor/issues)
[![GitHub forks](https://img.shields.io/github/forks/ctechhindi/Speed-Typing-Tutor.svg?style=flat-square)](https://github.com/ctechhindi/Speed-Typing-Tutor/network)
[![GitHub license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://github.com/ctechhindi/Speed-Typing-Tutor)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/ctechhindi/Speed-Typing-Tutor/issues)
[![HitCount](http://hits.dwyl.io/ctechhindi/Speed-Typing-Tutor.svg)](http://hits.dwyl.io/ctechhindi/Speed-Typing-Tutor)

<a href="https://speedtyping.netlify.com/#/"><img src="https://raw.githubusercontent.com/ctechhindi/Speed-Typing-Tutor/master/docs/images/speed-typing-tutor.png" alt="Speed Typing Tutor" style="max-width:100%;" width="600" height="315"></a>

## Library

- [Vue js](https://vuejs.org)
- [Buefy](https://buefy.github.io/) : `npm install --save buefy`
- [Material Design](https://github.com/Templarian/MaterialDesign) : `npm install mdi`
- [base64.js](https://github.com/dankogai/js-base64) : `npm install --save js-base64`
- [Countdown](https://github.com/xkeshi/vue-countdown) : `npm install --save @xkeshi/vue-countdown vue`
- [jQuery](https://www.npmjs.com/package/jquery) : `npm i jquery`
- [Vue-progressbar](http://hilongjw.github.io/vue-progressbar/index.html) : `npm install --save vue-progressbar`
- [Buefy](https://buefy.github.io/)
- [Material Design](https://github.com/Templarian/MaterialDesign)
- [base64.js](https://github.com/dankogai/js-base64)
- [Countdown](https://github.com/xkeshi/vue-countdown)
- [jQuery](https://www.npmjs.com/package/jquery)
- [Vue-progressbar](http://hilongjw.github.io/vue-progressbar/index.html)

## Electron

- [electron-builder configuration](https://www.electron.build/configuration/configuration)


## Browser Support

It's being tested on:

- Chrome (Latest)
- Firefox (Latest)
- Internet Explorer (Latest)
- Internet Explorer 10
- Safari (desktop and iOS)

Internet Explorer (10+) is only partially supported.

## Changelog

Details changes for each release are documented in the [changelog.md](changelog.md)

## License
## Copyright and License

MIT
Code copyright 2018 ctechhindi. Code released under the [MIT license](http://www.opensource.org/licenses/MIT)
6 changes: 6 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@

## Fix Issue

* "Invalid Host/Origin header" errors : `npm i webpack-dev-server`

### First Version Releases `00.1` pre-release

- Open Application in Full Screen
- Set Window Title with Version
- Change Electron Icon
Expand Down
Binary file added docs/images/speed-typing-tutor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/speed-typing-tutor.psd
Binary file not shown.
Loading

0 comments on commit 2528a87

Please sign in to comment.