sindresorhus/caprine

Newer

Older

Raw Normal view History

100644 162 lines (90 sloc) 4.96 KB

May 11, 2016 tweak icon placement in readme
May 11, 2016 tweak icon placement in readme	1	# Caprine <img src="static/Icon.png" width="60">
Sep 16, 2015 init
Sep 16, 2015 init	2
May 13, 2017 Improve readme
	3	> Elegant Facebook Messenger desktop app
	4
	5	Caprine is an unofficial and privacy focused Facebook Messenger app with many useful features.
Sep 16, 2015 init
Sep 16, 2015 init	6
May 24, 2017 Link to website from readme
May 24, 2017 Link to website from readme	7	[Website](https://sindresorhus.com/caprine)    [Discuss it on Product Hunt](https://www.producthunt.com/posts/caprine-2)
May 13, 2017 Add link to Product Hunt entry
May 13, 2017 Add link to Product Hunt entry	8
Apr 16, 2017 Fix name and link for Homebrew Cask in the readme (#177 )
	9	<br>
Mar 24, 2017 Update readme.md to fix broken link on screenshot (#175 )
	10
	11	<a href="https://github.com/sindresorhus/caprine/releases/latest">
	12	<img src="media/screenshot.png" width="846">
	13	</a>
Mar 11, 2017 Switch to `electron-builder`
	14
	15
May 13, 2017 Improve readme
	16	## Highlights
	17
	18	- [Dark theme](#dark-mode)
	19	- [Vibrant theme](#vibrancy)*
	20	- [Privacy focused](#hide-last-seen--typing-indicator)
	21	- [Keyboard shortcuts](#keyboard-shortcuts)
	22	- Cross-platform
	23	- Silent auto-updates
	24	- Custom text size
	25
	26	\*macOS only
	27
Mar 11, 2017 Switch to `electron-builder`
	28	## Install
	29
Mar 13, 2017 Readme tweaks
Mar 13, 2017 Readme tweaks	30	macOS 10.9+, Linux, and Windows 7+ are supported (64-bit only).
Mar 11, 2017 Switch to `electron-builder`
Mar 11, 2017 Switch to `electron-builder`	31
May 24, 2017 Link to website from readme
	32	Download the latest version on the [website](https://sindresorhus.com/caprine) or below.
	33
Mar 11, 2017 Switch to `electron-builder`
	34	### macOS
	35
	36	[Download](https://github.com/sindresorhus/caprine/releases/latest) the `.dmg` file.
	37
Apr 16, 2017 Fix name and link for Homebrew Cask in the readme (#177 )
	38	Or with [Homebrew-Cask](https://caskroom.github.io): `$ brew cask install caprine`
Mar 11, 2017 Switch to `electron-builder`
	39
	40	### Linux
	41
	42	[Download](https://github.com/sindresorhus/caprine/releases/latest) the `.AppImage` or `.deb` file.
	43
Mar 13, 2017 Readme tweaks
	44	The AppImage needs to be [made executable](http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80) after download.
	45
Mar 11, 2017 Switch to `electron-builder`
	46	### Windows
	47
	48	[Download](https://github.com/sindresorhus/caprine/releases/latest) the `.exe` file.
	49
May 6, 2017 Add unread count and taskbar overlay icon for Windows (#197 )
	50	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).
Sep 16, 2015 init
Sep 16, 2015 init	51
May 11, 2016 readme - move Features to the top
May 11, 2016 readme - move Features to the top	52
May 13, 2017 Improve readme
May 13, 2017 Improve readme	53	## Features
May 11, 2016 readme - move Features to the top
	54
	55	### Dark mode
	56
Mar 13, 2017 Move the dark mode and vibrancy toggle to the View menu
	57	You can toggle dark mode in the `View` menu or with <kbd>Cmd</kbd> <kbd>D</kbd> / <kbd>Ctrl</kbd> <kbd>D</kbd>.
May 11, 2016 readme - move Features to the top
May 11, 2016 readme - move Features to the top	58
Mar 11, 2017 Switch to `electron-builder`
Mar 11, 2017 Switch to `electron-builder`	59	<img src="media/screenshot-dark.png" width="846">
May 11, 2016 readme - move Features to the top
May 11, 2016 readme - move Features to the top	60
Mar 12, 2017 Add vibrancy effect to window on macOS (#163 )
	61	### Vibrancy
	62
Mar 13, 2017 Move the dark mode and vibrancy toggle to the View menu
	63	On macOS, you can toggle the window vibrancy effect in the `View` menu.
Mar 12, 2017 Add screenshot for the vibrancy effect
	64
	65	<img src="media/screenshot-vibrancy.jpg" width="1165">
Mar 12, 2017 Add vibrancy effect to window on macOS (#163 )
Mar 12, 2017 Add vibrancy effect to window on macOS (#163 )	66
May 13, 2017 Improve readme
	67	### Hide last seen / typing indicator
	68
	69	<img src="media/screenshot-block-typing-indicator.png" width="626">
	70
	71	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.
	72
Sep 20, 2016 Cmd hotkey thread switch (#130 )
	73	### Jump to conversation hotkey
	74
Sep 20, 2016 some tweaks
Sep 20, 2016 some tweaks	75	You can switch conversations similar to how you switch browser tabs: <kbd>Cmd/Ctrl</kbd> <kbd>n</kbd> (where `n` is `1` through `9`).
Sep 20, 2016 Cmd hotkey thread switch (#130 )
Sep 20, 2016 Cmd hotkey thread switch (#130 )	76
May 11, 2016 readme - move Features to the top
	77	### Compact mode
	78
	79	The interface adapts when resized to a small size.
	80
	81	<div align="center"><img src="media/screenshot-compact.png" width="512"></div>
	82
	83	### Desktop notifications
	84
	85	Desktop notifications can be turned on in Preferences.
	86
	87	<div align="center"><img src="media/screenshot-notification.png" width="358"></div>
	88
Nov 4, 2016 Add menu option for Always on Top (#134 )
	89	### Always on Top
	90
	91	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>.
	92
May 13, 2017 Improve readme
May 13, 2017 Improve readme	93	### Image paste confirmation
May 5, 2017 Add option to disable seen/typing indicators (#195 )
	94
May 13, 2017 Improve readme
May 13, 2017 Improve readme	95	Confirmation before sending images from the clipboard, to prevent accidental copy-pastes.
May 13, 2017 Add screenshot of the blocking typing indicator feature
	96
May 13, 2017 Improve readme
May 13, 2017 Improve readme	97	### Background behavior
May 5, 2017 Add option to disable seen/typing indicators (#195 )
	98
May 13, 2017 Improve readme
May 13, 2017 Improve readme	99	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.
May 5, 2017 Confirmation before sending image via Cmd/Ctrl+V (#198 )
	100
May 13, 2017 Improve readme
May 13, 2017 Improve readme	101	If you like to have Caprine minimized on startup, open it from the command-line with the `--minimize` flag.
May 5, 2017 Confirmation before sending image via Cmd/Ctrl+V (#198 )
	102
Sep 20, 2016 Cmd hotkey thread switch (#130 )
	103	### Keyboard shortcuts
	104
Nov 4, 2016 Add menu option for Always on Top (#134 )
	105	Description \| Keys
	106	-----------------------\| -----------------------
	107	New conversation \| <kbd>Cmd/Ctrl</kbd> <kbd>n</kbd>
	108	Search conversations \| <kbd>Cmd/Ctrl</kbd> <kbd>f</kbd>
	109	Toggle "Dark mode" \| <kbd>Cmd/Ctrl</kbd> <kbd>d</kbd>
	110	Next conversation \| <kbd>Cmd/Ctrl</kbd> <kbd>]</kbd> or <kbd>Ctrl</kbd> <kbd>Tab</kbd>
	111	Previous conversation \| <kbd>Cmd/Ctrl</kbd> <kbd>[</kbd> or <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>Tab</kbd>
	112	Jump to conversation \| <kbd>Cmd/Ctrl</kbd> <kbd>1</kbd>…<kbd>9</kbd>
	113	Mute conversation \| <kbd>Cmd/Ctrl</kbd> <kbd>Shift</kbd> <kbd>m</kbd>
	114	Archive conversation \| <kbd>Cmd/Ctrl</kbd> <kbd>Shift</kbd> <kbd>a</kbd>
	115	Delete conversation \| <kbd>Cmd/Ctrl</kbd> <kbd>Shift</kbd> <kbd>d</kbd>
	116	Toggle "Always on Top" \| <kbd>Cmd/Ctrl</kbd> <kbd>Shift</kbd> <kbd>t</kbd>
Mar 13, 2017 Readme tweaks
Mar 13, 2017 Readme tweaks	117	Toggle window menu \| <kbd>Alt</kbd> (Windows only)
Sep 20, 2016 some tweaks
Sep 20, 2016 some tweaks	118
May 11, 2016 readme - move Features to the top
	119
	120	---
Sep 16, 2015 init
	121
	122
	123	## Dev
	124
	125	Built with [Electron](http://electron.atom.io).
	126
Mar 13, 2017 Readme tweaks
Mar 13, 2017 Readme tweaks	127	### Run
Sep 16, 2015 init
Sep 16, 2015 init	128
Mar 13, 2017 Readme tweaks
	129	```
	130	$ npm install && npm start
	131	```
Sep 16, 2015 init
Sep 16, 2015 init	132
Mar 13, 2017 Readme tweaks
Mar 13, 2017 Readme tweaks	133	### Build
May 5, 2016 link to the Anatine app
May 5, 2016 link to the Anatine app	134
Mar 11, 2017 Switch to `electron-builder`
Mar 11, 2017 Switch to `electron-builder`	135	See the [`electron-builder` docs](https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build).
May 5, 2016 link to the Anatine app
May 5, 2016 link to the Anatine app	136
Mar 13, 2017 Readme tweaks
	137	### Publish
	138
	139	Use [`np`](https://github.com/sindresorhus/np) and for example run:
	140
	141	```
	142	$ np minor --no-publish
	143	```
	144
	145	Then edit the automatically created GitHub Releases draft, remove the `.pkg` file, and publish.
	146
May 5, 2016 link to the Anatine app
May 5, 2016 link to the Anatine app	147
May 5, 2017 Welcome @veniversum to the project! 🎉
	148	## Maintainers
	149
	150	- [Sindre Sorhus](https://sindresorhus.com)
	151	- [Aw Young Qingzhuo](https://github.com/veniversum)
	152
	153
May 13, 2017 Improve readme
	154	## Disclaimer
	155
	156	Caprine is a third-party app and is not affiliated with Facebook.
	157
	158
Sep 16, 2015 init
	159	## License
	160
May 5, 2017 Welcome @veniversum to the project! 🎉
May 5, 2017 Welcome @veniversum to the project! 🎉	161	MIT