Skip to content

Commit

Permalink
Update readme with new version screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
ssthouse committed Oct 18, 2018
1 parent 30e29e0 commit a01946f
Showing 1 changed file with 9 additions and 14 deletions.
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# github visualization
# Github visualization

> A simple project that viz your github repositories
> 一个可视化展示你的 Github 仓库的小项目
## Demo

link: https://ssthouse.github.io/github-visualization/#/main

### 效果图 2D / 2D Mode

![demo 2d](https://user-gold-cdn.xitu.io/2018/10/17/16681a0c00933e0b?w=1309&h=836&f=gif&s=4707231)

## Demo
### 效果图 3D / 3D Mode

![demo gif](https://raw.githubusercontent.com/ssthouse/github-visualization/master/screenshots/demo.gif)
![demo 3d](https://user-gold-cdn.xitu.io/2018/10/17/16681a0c00a1e0ce?w=949&h=836&f=gif&s=4248026)

## Develop

``` bash
```bash
# install dependencies
npm install

Expand All @@ -22,13 +27,3 @@ npm run dev
# build for production with minification (this cmd will generate file for github page ==> in `docs` folder)
npm run build
```



## TODO

- 3D version
- [ ] Display same effect like 2D version
- [ ] Add interaction to the 3D view
- Fix issues
- Add some loading UI after user click **show** button

0 comments on commit a01946f

Please sign in to comment.