Update README.md with Credits and remove nodejs refs
This commit is contained in:
@@ -1,19 +1,15 @@
|
||||
# Gravatar GNOME Shell Extension
|
||||
[![Build Status][travis-image]][travis-url] [![Dependency Status][deps-image]][deps-url]
|
||||
|
||||
A GNOME Shell extension to synchronize your user icon with Gravatar.
|
||||
|
||||
## Prerequisites
|
||||
* `gnome-shell`
|
||||
* `dconf` _(optional)_
|
||||
* `gnome-tweaks` _(optional)_
|
||||
* `gnome-shell-extension-prefs` _(optional)_
|
||||
|
||||
## Installation
|
||||
If you wish to build and install the extension manually, you will need the following tools:
|
||||
* `git`
|
||||
* `npm` - Node Package Manager
|
||||
* `node` - Node.js (>= 8.0.0)
|
||||
* `glib-compile-schemas`
|
||||
* `dconf` _(optional)_
|
||||
|
||||
@@ -24,19 +20,17 @@ The packages which include the above tools may vary between different GNU/Linux
|
||||
git clone https://github.com/dsheeler/gnome-shell-extensions-gravatar.git
|
||||
# enter the local repository directory
|
||||
cd gnome-shell-extensions-gravatar
|
||||
# install the local build dependencies
|
||||
npm install
|
||||
# run the build/install toolchain
|
||||
npm run install-extension
|
||||
make
|
||||
```
|
||||
|
||||
#### Uninstall
|
||||
```bash
|
||||
npm run uninstall-extension
|
||||
make uninstall
|
||||
```
|
||||
|
||||
## Settings
|
||||
Settings can be configured from the `gnome-tweaks` or `gnome-shell-extension-prefs` tools or from the command line via `dconf`. Settings marked with `*` can only be changed by using `dconf`.
|
||||
Settings can be configured from the `gnome-shell-extension-prefs` tool or from the command line via `dconf`. Settings marked with `*` can only be changed by using `dconf`.
|
||||
|
||||
#### *Debug Mode: _(default: `false`)_
|
||||
```bash
|
||||
@@ -48,6 +42,11 @@ dconf write /org/gnome/shell/extensions/gravatar/debug "'<BOOL>'"
|
||||
dconf write /org/gnome/shell/extensions/gravatar/email "'<EMAIL>'"
|
||||
```
|
||||
|
||||
### Get Avatar Keybinding: _(default: `["<Ctrl><Super>g"]`)_
|
||||
```bash
|
||||
dconf write /org/gnome/shell/extensions/gravatar/gravatar-ondemand-keybinding '["<KEYBINDING_STRING>"]'
|
||||
```
|
||||
|
||||
#### *Icon Size: _(default: `192`)_
|
||||
* **1 - 2048 pixel square** _(See: [gravatar.com](https://en.gravatar.com/site/implement/images/#size))_
|
||||
|
||||
@@ -58,11 +57,6 @@ dconf write /org/gnome/shell/extensions/gravatar/icon-size <SIZE>
|
||||
## Bug Reporting
|
||||
Bugs should be reported via the [GitHub Issue Tracker](https://github.com/dsheeler/gnome-shell-extensions-gravatar/issues)
|
||||
|
||||
## Development
|
||||
You can run the extension in development mode with `npm run dev`. This will install the extension as a symlink to your development build dir and automatically rebuild when source files are changed.
|
||||
|
||||
To reload the extension you must reload GNOME with `Alt + F2, r, [ENTER]`.
|
||||
|
||||
#### Logs
|
||||
##### Extension
|
||||
```bash
|
||||
@@ -73,6 +67,8 @@ journalctl /usr/bin/gnome-shell -f
|
||||
```bash
|
||||
gnome-shell-extension-prefs gravatar@gnome-shell-extensions.dsheeler.net
|
||||
```
|
||||
## Credits
|
||||
This project is a fork of Daniel Demus' fork of the original Gravatar extension by Jon Rouleau.
|
||||
|
||||
## License
|
||||
The MIT License (MIT)
|
||||
|
||||
Reference in New Issue
Block a user