update readme with snew instructions for github + rollbar (maybe)

This commit is contained in:
Tristan Homsi
2018-07-12 23:24:26 -04:00
parent 013a810370
commit eab84137e5
4 changed files with 19 additions and 38 deletions

1
.gitignore vendored
View File

@@ -6,7 +6,6 @@ node_modules/
node_modules.bak/
build/
src\excisor\npm-debug\.log$
rollbar.json$
*.suo
obj/
node_modules/*

View File

@@ -244,7 +244,7 @@ module.exports = function(grunt) {
comments: 'some'
},
files: {
'dest/bookmarklet.js': ['src/bookmarklet.js']
'dest/bookmarklet.js': ['src/bookmarklet.js'],
}
}
},
@@ -274,13 +274,9 @@ module.exports = function(grunt) {
// version: '<%= pkg.version %>'
// },
// version:
// 'https://' +
// azure.AZURE_STORAGE_ACCOUNT +
// '.blob.core.windows.net/bookcision/<%= pkg.version %>/<%= pkg.moduleName %>.js',
// '',
// latest:
// 'https://' +
// azure.AZURE_STORAGE_ACCOUNT +
// '.blob.core.windows.net/bookcision/latest/<%= pkg.moduleName %>.js'
// '',
// },
// livereload server

View File

@@ -1,8 +1,8 @@
# Bookcision
http://www.norbauer.com/bookcision/
Created by [Ryan Norbauer](http://ryan.norbauer.com/)
http://twitter.com/NorbauerApps
Maintained by [Readwise](https://readwise.io)
When highlights and notes are created on any Kindle device, they are synced up to Amazon's cloud. These are then visible at read.amazon.com, but there is no reason to believe that Amazon will continue to provide this service forever, and our ability to work with text in that hosted browser-based environment is limited. This is a bookmarklet that permits one to excise notes/highlights from read.amazon.com. It yields a single page of cleanly styled notes/highlights, which can then be copied to one's clipboard and pasted into a local text repository (OneNote, Evernote, DevonThink, etc.). The highlights and notes can also be downloaded in a number of formats (e.g. JSON).
@@ -12,35 +12,21 @@ When highlights and notes are created on any Kindle device, they are synced up t
### Setting up project for development
1. hg clone the project locally.
1. git clone the project locally.
1. Ensure you're using Node 0.10.35 (we recommend using [nvm](https://github.com/creationix/nvm) to do this)
1. npm install
1. Copy *.example.json to *.json and fill in real credentials.
### Installing a module
rm npm-shrinkwrap.json & npm i [MODULE] --save & npm shrinkwrap
### Updating all packages
........
### Compiling changes locally
Run `grunt build` -- dest/bookcision.js will be the compiled, working bookmarklet.
### Releasing a version
### Releasing a new version (for maintainers)
1. Commit code with a sensible comment.
1. `grunt release:prerelease` to:
1. Increment the version number (using `npm version prerelease`).
1. Commit the change to the repository.
1. Publish to Azure (but not the directory served publicly).
1. Notify Rollbar of the new sourcemap to download.
or `grunt release:major`, `release:minor`, or `release:patch` to perform the steps above and additionally release live (publish to the 'latest' directory in Azure).
### Testing CORS support on Azure
```
Preflight request:
curl -H "Origin: https://read.amazon.com" -H "Access-Control-Request-Method: GET" -i -X OPTIONS --verbose http://norbauercdn.blob.core.windows.net/bookcision/latest/bookcision.js
```
```
curl -H "Origin: https://read.amazon.com" --verbose http://norbauercdn.blob.core.windows.net/bookcision/latest/bookcision.js
```
1. Bump the version number of Bookcision in package.json
1. Run `grunt build`
1. Copy dest/bookcision.js to dist/bookcision.js (replacing the old version)
1. That's it! The new version will be at dist/bookcision.js and automatically updated via Github's CDN as soon as the change is merged into master.

10
dist/bookcision.js vendored

File diff suppressed because one or more lines are too long