From 24fe70f0bd676bdffefb234ae0947080a0fc1177 Mon Sep 17 00:00:00 2001 From: dextermallo Date: Sat, 3 Aug 2024 13:27:09 +0800 Subject: [PATCH] chore: remove space & duplicate sections --- .github/README.md | 21 +++++++-------------- personal-security-checklist.yml | 8 +------- 2 files changed, 8 insertions(+), 21 deletions(-) diff --git a/.github/README.md b/.github/README.md index e9a6d58..06d481e 100644 --- a/.github/README.md +++ b/.github/README.md @@ -34,7 +34,7 @@ You can read the full checklist in [`CHECKLIST.md`](https://github.com/Lissy93/p ## The Website -The easiest method for consuming the checklist is via our website, at: **[digital-defense.io](https://digital-defense.io/)** +The easiest method for consuming the checklist is via our website: **[digital-defense.io](https://digital-defense.io/)** Here you can browse lists, filter by your threat model and tick items off once complete (plus, there are pretty charts to make you feel good about your progress ☺️). @@ -49,17 +49,17 @@ The site is built with Qwik, using TypeScript and some components from DaisyUI. ### Developing To run the app locally, or to make code changes, you'll need Node and Git installed. -1. Grab the code: `git@github.com:Lissy93/personal-security-checklist.git` -2. Navigate into source: `cd personal-security-checklist/web` +1. Grab the code: `git clone git@github.com:Lissy93/personal-security-checklist.git` +2. Navigate into the source: `cd personal-security-checklist/web` 3. Install dependencies: `yarn` 4. Start the development server: `yarn dev` Alternatively, just open this repo in Code Spaces, where everything is already configured and ready to go. ### Deploying -To deploy the app, follow the developing steps above, then run `yarn build`,`yarn build.static`. You can then deploy it by copying the `dist/` directory to any CDN, web server or static hosting provider of your choice. +To deploy the app, follow the developing steps above, then run `yarn build`, `yarn build.static`. You can then deploy it by copying the `dist/` directory to any CDN, web server or static hosting provider of your choice. -Alternatively, fork the repo and import into your providers dashboard. Or use the link below for an easy 1-click deploy πŸ˜‰ +Alternatively, fork the repo and import it into your providers' dashboard. Or use the link below for an easy 1-click deployment πŸ˜‰ --- @@ -77,15 +77,8 @@ Base: digital-defense.io/api /api/checklists/[name]/[point-index] /api/search/[searchterm] - -### Developing - -### Deploying - ---- - ## Contributing -All checklist data is stored in [`personal-security-checklist.yml`](https://github.com/Lissy93/personal-security-checklist/blob/HEAD/personal-security-checklist.yml). This is pulled in the website at build-time, and referenced by the API, and is also dynamically inserted into the markdown [Checklist page](https://github.com/Lissy93/personal-security-checklist/blob/HEAD/CHECKLIST.md). +All checklist data is stored in [`personal-security-checklist.yml`](https://github.com/Lissy93/personal-security-checklist/blob/HEAD/personal-security-checklist.yml). This is pulled in the website at build-time and referenced by the API, and is also dynamically inserted into the markdown [Checklist page](https://github.com/Lissy93/personal-security-checklist/blob/HEAD/CHECKLIST.md). So if you only wish to make changes to the data, this is the only file you need to edit. @@ -93,7 +86,7 @@ Important: When submitting your pull request, provide references backing up any For modifying the website or API source, see the developing sections above for instructions on running locally. -Prior to submitting an issue or PR, please ensure you've followed the [community guidelines](https://github.com/Lissy93/personal-security-checklist/blob/master/.github/CONTRIBUTING.md) and followed the [Code of Conduct](https://github.com/Lissy93/personal-security-checklist/blob/HEAD/.github/CODE_OF_CONDUCT.md). +Before submitting an issue or PR, please ensure you've followed the [community guidelines](https://github.com/Lissy93/personal-security-checklist/blob/master/.github/CONTRIBUTING.md) and followed the [Code of Conduct](https://github.com/Lissy93/personal-security-checklist/blob/HEAD/.github/CODE_OF_CONDUCT.md). --- diff --git a/personal-security-checklist.yml b/personal-security-checklist.yml index 349816f..e942f88 100644 --- a/personal-security-checklist.yml +++ b/personal-security-checklist.yml @@ -850,7 +850,6 @@ url: https://github.com/Lissy93/awesome-privacy#p2p-messaging color: cyan - - title: Social Media slug: social-media description: Minimizing the risks associated with using online communities @@ -972,7 +971,6 @@ url: https://github.com/Lissy93/awesome-privacy#news-readers-and-aggregation color: blue - - title: Networks slug: networks description: Safeguarding your network traffic @@ -1148,7 +1146,6 @@ - title: Self-Hosted Network Security Tools url: https://github.com/Lissy93/awesome-privacy#self-hosted-network-security - - title: Mobile Devices slug: mobile-devices description: Reduce invasive tracking for cells, smartphones and tablets @@ -1330,7 +1327,6 @@ - title: Mobile Operation Systems url: https://github.com/Lissy93/awesome-privacy#mobile-operating-systems - - title: Personal Computers slug: personal-computers description: Securing your PC's operating system, data & activity @@ -1562,8 +1558,6 @@ - title: File Encryption url: https://github.com/Lissy93/awesome-privacy#file-encryption - - - title: Smart Home slug: smart-home description: Using IoT devices without compromising your privacy @@ -1664,7 +1658,6 @@ - title: AI Voice Assistants url: https://github.com/Lissy93/awesome-privacy#ai-voice-assistants - - title: Personal Finance slug: personal-finance description: Protecting your funds, financial accounts and transactions @@ -1872,6 +1865,7 @@ Opt for anonymous payment methods like cryptocurrencies to avoid entering identifiable information online. color: indigo + - title: Physical Security slug: physical-security description: Taking measures to prevent IRL security incidents