Skip to content

Commit

Permalink
Neaten readme, bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
Terrance committed Oct 17, 2015
1 parent e43fbfb commit 5addbf2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 22 deletions.
2 changes: 1 addition & 1 deletion Homely/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "Homely",
"short_name": "Homely",
"description": "A custom New Tab page, providing a quick, customizable layout of links and menus, as well as simple bookmark and history components.",
"version": "1.5.4",
"version": "1.6",
"author": "Ollie Terrance",
"homepage_url": "https://github.com/OllieTerrance/Homely",
"incognito": "split",
Expand Down
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,16 @@
Introduction
============
# Homely

Homely is a custom New Tab page replacement for Google Chrome. It aims to provide a quick, customizable layout of links and menus, as well as simple bookmarks and history components.


Running from source
===================

This project requires the following libraries:
## Requirements

* [Bootstrap](http://getbootstrap.com)
* [Font Awesome](http://fontawesome.io)
* [jQuery](http://jquery.com)
* [HTML5 Sortable](http://farhadi.ir/projects/html5sortable/)
* [Mousetrap](http://craig.is/killing/mice)

Batteries are not included - the CSS and JavaScript files need to be placed in a `lib` folder with appropriate `css` and `js` subfolders (check the HTML file for where files are linked to).


Using Homely
============

Keyboard shortcuts
------------------
## Keyboard shortcuts

If enabled, the page can be navigated by keyboard. Note that Chrome will, by default, give focus to the onmibox when opening a new tab, so you must first `Tab` into the page.

Expand Down Expand Up @@ -71,8 +59,7 @@ If enabled, the page can be navigated by keyboard. Note that Chrome will, by de

* `?` - show keyboard shortcuts modal

Links format
------------
## Links format

Links can be edited in JSON from the Settings modal. The basic format is as follows:

Expand Down Expand Up @@ -141,8 +128,7 @@ With the above steps, you should end up with a block and dropdown like this:

![Search Engines example](http://i.imgur.com/V6jkCoj.png)

Notifications
-------------
## Notifications

Enabling a notification option will prompt for the relevant permission in order to access the given website (and the corresponding block will be highlighted with green text). Disabling it will not immediately remove this, but any unnecessary permissions will be dropped when settings are saved.

Expand All @@ -154,7 +140,6 @@ In order to read arbitrary websites, the global permissions `http://*/` and/or `

The Gmail notifier can be configured for multiple accounts by specifying the user indexes (as can be found in a Google URL with `?authuser=X` or `/u/X/`). If a user is not signed in, or does not have a Gmail account, an Authentication Required dialog will display from attempting to access the feed unauthorized.

Incognito mode
--------------
## Incognito mode

If Homely is allowed to run in incognito mode, it will also display as the New Tab page of incognito windows. It shares settings with normal windows, however history and notifications are disabled.

0 comments on commit 5addbf2

Please sign in to comment.