From 63e14e308703c458584934a156876e00e8277cf9 Mon Sep 17 00:00:00 2001 From: Brian Lovin Date: Sun, 13 Jan 2019 12:41:49 -0800 Subject: [PATCH] Readme --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aa9660d..2b78a88 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ -# security-checklist -A checklist for staying safe on the internet +# Security checklist +A checklist for staying safe on the internet. + +### Motivation +This project is the result of a conversation started during a [recent episode](https://spec.fm/podcasts/design-details/249464) of the [Design Details Podcast](https://spec.fm/podcasts/design-details/) and a subsequent tweet by [Michael Knepprath](https://twitter.com/mknepprath/status/1083966912420372481). + +### Contributing +This project should be considered a living document of resources and applications that improve people's digital security and privacy. Contributions, edits, and extensions are welcome! + +If you have resources to add to existing sections, please open a pull request. + +- Aim for reputable sources for guides and new coverage +- If adding an app, please include links to as many platforms as possible. See `config/*.js` for examples of how data is formatted. + +If you would like to create a new category of security and privacy resources, please open an issue first with your proposed category. Please explain why this additional category should stand alone from other existing sections. + +### Run this locally +1. `$ git clone git@github.com:brianlovin/security-checklist.git` +2. `$ cd security-checklist` +3. `$ npm install` +4. `$ npm run dev` +5. View the running app in your browser at `http://localhost:3000` +6. Optional: deploy this yourself with ZEIT + Now by configuring `now.json` and running `$ now` + +### Feedback +Please open issues at any time for general feedback, or you can reach me directly at hi@brianlovin.com. \ No newline at end of file