fix #249: update README to match smaller DB #250
Conversation
groovecoder
requested review from
nhnt11,
lesleyjanenorton and
pdehaan
and removed request for
nhnt11
README.md
Outdated
| @@ -1,21 +1,16 @@ | |||
| # Breach Alerts | |||
| # blurts-server | |||
There was a problem hiding this comment.
Odd change... Bonus points if we can just change this to "Firefox Monitor Server" or something readable, since "blurt" is confusing.
|
|
||
| Communicates with the [blurts-addon](https://github.com/mozilla/blurts-addon) client-side add-on for Firefox Monitor. | ||
| This code is for the monitor.firefox.com service & website. |
There was a problem hiding this comment.
Why remove the link to the add-on?
There was a problem hiding this comment.
It doesn't actually communicate with the add-on at all. The add-on just sends users to the site.
There was a problem hiding this comment.
OK, makes sense. I think I just liked the add-on repo link because it was the only place that I recall that mentioned the add-on portion of the project.
But maybe that will be moot if the add-on code gets moved into tree or not.
README.md
Outdated
|
|
||
| ## Context | ||
| Brech data is powered by [haveibeenpwned.com](https://haveibeenpwned.com/). |
README.md
Outdated
|
|
||
| * `node scripts/add-breached-emails.js --help` for usage help. | ||
| ``` | ||
| ./node_modules/.bin/knex --knexfile db/knexfile.js migrate:latest |
There was a problem hiding this comment.
nit: Not sure if it's worth adding these to an npm script to avoid having to use the ./node_modules/bin/ prefix, and we could just run $ npm run db:migrate.
Where package.json has the following script:
"db:migrate": "knex --knexfile db/knexfile.js migrate:latest"There was a problem hiding this comment.
Good catch. We already have a migrate script so I changed it to db:migrate and updated README to match.
README.md
Outdated
| @@ -102,23 +109,6 @@ OAUTH_TOKEN_URI="https://oauth-stable.dev.lcip.org/v1/token" | |||
|
|
|||
| #### Breach Hashsets | |||
and drop other things we don't need like AWS creds
groovecoder
force-pushed
the
update-README-249
branch
from
a9d752e to
15123b5
Compare
and drop other things we don't need like AWS creds