Skip to content

Commit

Permalink
show how to persist data between restarts (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
Andy McKay authored and wbamberg committed Apr 27, 2017
1 parent 48d7eb4 commit f7c8862
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
11 changes: 9 additions & 2 deletions quicknote/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Quicknote

A persistent note/to-do list application — click a button in your browser and record notes, which will persist even after browser restarts.

Works in Firefox 47+, and will also work as a Chrome extension, out of the box.
Works in Firefox 47+.

## Running with web-ext

[web-ext](https://developer.mozilla.org/en-US/Add-ons/WebExtensions) generates a new profile on each run, meaning your data is not persisted between Firefox runs. To use web-ext and preserve this information, you will need an existing or new Firefox profile. Then run:

web-ext run --firefox-profile [A PATH TO A FIREFOX PROFILE] --keep-profile-changes

## What it does

Expand All @@ -12,7 +19,7 @@ This extension includes:
* A list of the notes that have been added to the extension — each note includes a delete button to delete just that note. You can also click on the note title and body to edit them. In edit mode, each note includes:
* An update button to submit an update.
* A cancel button to cancel the update.

Quicknote uses the WebExtensions [Storage API](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/storage) to persist the notes.

## What it shows
Expand Down
11 changes: 9 additions & 2 deletions quicknote/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

"manifest_version": 2,
"name": "Quicknote",
"version": "1.0",
"version": "1.1",

"description": "Allows the user to make quick notes by clicking a button and entering text into the resulting popup. The notes are saved in storage. See https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Examples#quicknote",
"icons": {
Expand All @@ -11,13 +11,20 @@

"permissions": [
"storage"
],
],

"browser_action": {
"default_icon": {
"32" : "icons/quicknote-32.png"
},
"default_title": "Quicknote",
"default_popup": "popup/quicknote.html"
},

"applications": {
"gecko": {
"id": "quicknote-example@mozilla.org"
}
}

}

0 comments on commit f7c8862

Please sign in to comment.