Skip to content

Commit

Permalink
README modified. Beta is out
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcat323 committed Oct 12, 2018
1 parent 39ca2c3 commit a6df627
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 3 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,25 @@

> Search GitHub repositories. Project based on Vue JS, created for practicing Vue JS, Vuex
## Build Setup
## 0.0.4-beta
For now it's *BETA* and it doesn't mean that you shouldn't use it, you have to use it. The project was created just for a practice, will be improved step by step.
### CHANGELOG: Or what's new
* Now you can view over 100 repositories per page.
* You can use pagination (for now it's pager).
* Bugs been fixed.

## Get started
Alright, you just got know what's new here, let's get started with using it. After you Sir.
#### Clone it to your machine
```BASH
git clone https://github.com/mrcat323/github-searcher
cd github-searcher
```
#### Remove all "trash"
```BASH
rm -R dist # delete build directory, for recompiling it
```
#### Build Setup

```BASH
# install dependencies
Expand All @@ -14,5 +32,9 @@ npm run dev
# build for production with minification
npm run build
```
**Use it, test it & enjoy :smiley:**

### Contributing
Hey, also you can help with the project, add something new, provide ideas, code. For that, just fork this repository, test, and change to all everything you want.

For detailed explanation on how things work, consult the [docs for vue-loader](http://vuejs.github.io/vue-loader).
**Hope you enjoyed with all of these stuff.** :cat2:
17 changes: 17 additions & 0 deletions dist/build.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dist/build.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "github-searcher",
"description": "Search GitHub repositories. Project based on Vue JS, created for practicing Vue JS, Vuex",
"description": "Search repositories over GitHub. Project based on Vue JS, created for practicing Vue JS, Vuex",
"version": "0.0.4-beta",
"author": "Mr. CaT <[email protected]>",
"license": "MIT",
Expand Down

0 comments on commit a6df627

Please sign in to comment.