Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed May 13, 2017
1 parent e3b149f commit 3a2514a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[{package.json,*.yml}]
[*.yml]
indent_style = space
indent_size = 2
44 changes: 32 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Caprine <img src="static/Icon.png" width="60">

> Unofficial Facebook Messenger app
> Elegant Facebook Messenger desktop app
Caprine is an unofficial and privacy focused Facebook Messenger app with many useful features.

<br>

Expand All @@ -9,6 +11,18 @@
</a>


## Highlights

- [Dark theme](#dark-mode)
- [Vibrant theme](#vibrancy)*
- [Privacy focused](#hide-last-seen--typing-indicator)
- [Keyboard shortcuts](#keyboard-shortcuts)
- Cross-platform
- Silent auto-updates
- Custom text size

\*macOS only

## Install

*macOS 10.9+, Linux, and Windows 7+ are supported (64-bit only).*
Expand All @@ -31,13 +45,8 @@ Or with [Homebrew-Cask](https://caskroom.github.io): `$ brew cask install caprin

*For taskbar notification badges to work on Windows 10, you'll need to [enable it in Taskbar Settings](https://www.tenforums.com/tutorials/48186-taskbar-buttons-hide-show-badges-windows-10-a.html).*

## Features

### Background behavior

When closing the window, the app will continue running in the background, in the dock on macOS and the tray on Linux/Windows. Right-click the dock/tray icon and choose `Quit` to completely quit the app. On macOS, click the dock icon to show the window. On Linux, right-click the tray icon and choose `Toggle` to toggle the window. On Windows, click the tray icon to toggle the window.

If you like to have Caprine minimized on startup, open it from the command-line with the `--minimize` flag.
## Features

### Dark mode

Expand All @@ -51,6 +60,12 @@ On *macOS*, you can toggle the window vibrancy effect in the `View` menu.

<img src="media/screenshot-vibrancy.jpg" width="1165">

### Hide last seen / typing indicator

<img src="media/screenshot-block-typing-indicator.png" width="626">

You can choose to prevent people from knowing when you've seen a message or are currently typing. Both options are available under the `Caprine`/`File` menu.

### Jump to conversation hotkey

You can switch conversations similar to how you switch browser tabs: <kbd>Cmd/Ctrl</kbd> <kbd>n</kbd> (where `n` is `1` through `9`).
Expand All @@ -71,15 +86,15 @@ Desktop notifications can be turned on in Preferences.

You can toggle whether Caprine stays on top of other windows in the `Window`/`View` menu or with <kbd>Cmd/Ctrl</kbd> <kbd>Shift</kbd> <kbd>t</kbd>.

### Hide last seen / typing indicator
### Image paste confirmation

<img src="media/screenshot-block-typing-indicator.png" width="626">
Confirmation before sending images from the clipboard, to prevent accidental copy-pastes.

You can choose to prevent people from knowing when you've seen a message or are currently typing. Both options are available under the `Caprine`/`File` menu.
### Background behavior

### Image paste confirmation
When closing the window, the app will continue running in the background, in the dock on macOS and the tray on Linux/Windows. Right-click the dock/tray icon and choose `Quit` to completely quit the app. On macOS, click the dock icon to show the window. On Linux, right-click the tray icon and choose `Toggle` to toggle the window. On Windows, click the tray icon to toggle the window.

Confirmation before sending images from the clipboard, to prevent accidental copy-pastes.
If you like to have Caprine minimized on startup, open it from the command-line with the `--minimize` flag.

### Keyboard shortcuts

Expand Down Expand Up @@ -132,6 +147,11 @@ Then edit the automatically created GitHub Releases draft, remove the `.pkg` fil
- [Aw Young Qingzhuo](https://github.com/veniversum)


## Disclaimer

Caprine is a third-party app and is not affiliated with Facebook.


## License

MIT

0 comments on commit 3a2514a

Please sign in to comment.