Skip to content

Commit

Permalink
Update README (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
richardscarrott committed May 12, 2018
1 parent 258b288 commit 83834d2
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 8 deletions.
26 changes: 21 additions & 5 deletions README.md
@@ -1,8 +1,8 @@
# Snippets

The Snippets chrome extension provides easy access to JavaScript snippets, allowing you to manage and maintain your snippets using GitHub.
<p align="center">
<img src="artwork/marquee-promo-tile.png" alt="Context Menu Example">
</p>

Currently there are two views for your snippets:
Snippets is a Chrome extension which pulls in JavaScript code snippets from any GitHub repository (including GitHub Enterprise), allowing them to be executed via the context menu or omnibox.

## Context Menu
The context menu provides easy access and discovery of snippets by right clicking anywhere in the page. Clicking on a snippet will execute it in the current tab.
Expand All @@ -12,14 +12,30 @@ The context menu provides easy access and discovery of snippets by right clickin
</p>

## Omnibox
The omnibox is the fastest way to find and execute a snippet allowing you to fuzzy search all available snippets. To activate the Snippets omnibox, focus on the address bar and type '`s`' then `tab` or `space`. Once activated you can begin to fuzzy search.
The omnibox allows you to fuzzy search all available snippets.

To activate the Snippets omnibox, focus on the address bar and type '`s`' then `tab` or `space`. Once activated you can begin to fuzzy search.

> :bulb: You can use `⌘+l` to jump straight to the address bar.
<p align="center">
<img src="docs/omnibox.gif" alt="Context Menu Example">
</p>

## Recommended snippets

https://github.com/bgrins/devtools-snippets/tree/master/snippets

## FAQ

### What are snippets?
Snippets are small JS scripts which can be executed within the context of any webpage. A Snippet could do just about anything you can think of, for example it could [pretty print the search query](https://github.com/bgrins/devtools-snippets/tree/3bc7d150e1d0bd7ff27be4df15e949bee94456ff/snippets/querystringvalues) or maybe autofill a large form.

### Why not use the [snippets built-in to Chrome DevTools](https://developers.google.com/web/tools/chrome-devtools/snippets)?
DevTools doesn't provide a way to easily share snippets with your team or the open source community.

DevTools requires you to author and maintain snippets in a custom editor (albeit, quite a good editor).

## License

MIT
3 changes: 2 additions & 1 deletion manifest.json
Expand Up @@ -2,7 +2,8 @@
"name": "Snippets",
"version": "0.2.5",
"manifest_version": 2,
"description": "Add JavaScript snippets to your context menu",
"description":
"Pulls in JavaScript code snippets from any GitHub repository (including GitHub Enterprise), allowing them to be executed via the context menu or omnibox",
"homepage_url": "http://github.com/richardscarrott/snippets",
"omnibox": { "keyword": "s" },
"icons": {
Expand Down
6 changes: 4 additions & 2 deletions package.json
@@ -1,12 +1,14 @@
{
"name": "snippets",
"version": "1.0.0",
"description": "Add JavaScript snippets to your context menu",
"description":
"Pulls in JavaScript code snippets from any GitHub repository (including GitHub Enterprise), allowing them to be executed via the context menu or omnibox",
"main": "index.js",
"scripts": {
"test": "jest",
"prestart": "npm run clean",
"start": "webpack --config ./build/webpack-config.js --env development --watch",
"start":
"webpack --config ./build/webpack-config.js --env development --watch",
"prebuild": "npm run clean",
"build": "webpack --config ./build/webpack-config.js --env production",
"clean": "rm -rf dist",
Expand Down

0 comments on commit 83834d2

Please sign in to comment.