Skip to content
This repository has been archived by the owner on Apr 7, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
k0kubun committed Aug 24, 2015
1 parent d2fdcba commit a510331
Showing 1 changed file with 32 additions and 33 deletions.
65 changes: 32 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,45 @@

YoruFukurou-like Twitter Client built on Electron

![](https://i.gyazo.com/f50b8192eed6adfcb49c9b3374d5a7bb.png)

## Features
- [x] Realtime timeline using UserStream
- [x] Vim-like key bindings

## TODO

- [x] Show timeline
- [x] UserStream
- [x] Show Icon
- [x] Tweet view
- [x] Post Tweet
- [x] Select Tweet
- [x] Delete Tweet
- [x] Reply
- [x] Show command buttons
- [x] Favorite
- [x] Show time
- [x] Authentication
- [x] Tab change
- [x] Mention
- [x] Refresh
- [x] Home
- [x] Background shadow
- [x] Header button detail
- [x] List
- [x] Search
- [x] Basic key bindings (f, Enter, Tab)
- [x] Vim-like Key Binding (j, k, 0)
- [x] Moving scroll animation
- [x] Delayed tweet animation

## Build
- Realtime timeline using UserStream
- Vim-like key bindings

### Demo

![](https://i.gyazo.com/3f89eaf9e85820ef0ba79bc2db7c478e.gif)

## Installation

Download an archive from following link and unzip it.

https://github.com/k0kubun/Nocturn/releases

## Key bindings

|Key|Command|
|:---|:---|
|Enter| Tweet, Reply, Search |
|j, ↓|Select next tweet|
|k, ↑|Select previous tweet|
|0, space|Select first tweet|
|f|Add tweet to favorites|

## Development

```bash
$ bundle install
$ rake compile
$ npm install
$ npm start
```

## Build package

```bash
$ npm build
```

## License

MIT License

0 comments on commit a510331

Please sign in to comment.