Skip to content

Commit

Permalink
Updated documentation links and read me to reflect status
Browse files Browse the repository at this point in the history
  • Loading branch information
shombando committed Nov 18, 2022
1 parent 565b81c commit ff73ee3
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
10 changes: 5 additions & 5 deletions keyoxidizer.sh
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ reddit()

echo -e "Log into your Reddit account and create a new post on your profile"
echo -e "Paste in the following as the content:"
echo -e "This is an OpenPGP proof that connects my OpenPGP key to this Reddit account. For details check out https://keyoxide.org/guides/openpgp-proofs\n\n[Verifying my OpenPGP key: openpgp4fpr:$fingerPrint]"
echo -e "This is an OpenPGP proof that connects my OpenPGP key to this Reddit account. For details check out https://docs.keyoxide.org/service-providers/reddit/\n\n[Verifying my OpenPGP key: openpgp4fpr:$fingerPrint]"

read -p "Have completed this step (y/N): " keyoxidizer_response
if [ "$keyoxidizer_response" == "y" ]; then
Expand Down Expand Up @@ -154,7 +154,7 @@ github()

read -p "Enter your Github username: " keyoxidizer_username
echo -e "Log into your Github account and create a new gist called 'openpgp.md'. \nPaste the following into the gist and be sure to select 'Create public gist':"
echo -e "This is an OpenPGP proof that connects [my OpenPGP key](https://keyoxide.org/$fingerPrint) to [this Github account](https://github.com/$keyoxidizer_username). For details check out https://keyoxide.org/guides/openpgp-proofs\n\n[Verifying my OpenPGP key: openpgp4fpr:$fingerPrint]"
echo -e "This is an OpenPGP proof that connects [my OpenPGP key](https://keyoxide.org/$fingerPrint) to [this Github account](https://github.com/$keyoxidizer_username). For details check out https://docs.keyoxide.org/service-providers/github/\n\n[Verifying my OpenPGP key: openpgp4fpr:$fingerPrint]"

read -p "Have completed this step (y/N): " keyoxidizer_response
if [ "$keyoxidizer_response" == "y" ]; then
Expand Down Expand Up @@ -186,7 +186,7 @@ twitter()
fingerPrint=`cat keyoxidizer.fingerprint`

echo -e "Log into your Twitter account tweet out this status:"
echo -e "This is an OpenPGP proof that connects my OpenPGP key to this Twitter account. For details check out https://keyoxide.org/guides/openpgp-proofs \n\
echo -e "This is an OpenPGP proof that connects my OpenPGP key to this Twitter account. For details check out https://docs.keyoxide.org/service-providers/twitter/ \n\
[Verifying my OpenPGP key: openpgp4fpr:$fingerPrint]"

read -p "Have completed this step (y/N): " keyoxidizer_response
Expand All @@ -204,7 +204,7 @@ hackernews()

echo -e "Log into hackernews and click on your username."
echo -e "Add the following lines to your about:"
echo -e "This is an OpenPGP proof that connects my OpenPGP key to this Hackernews account. For details check out https://keyoxide.org/guides/openpgp-proofs\n\n[Verifying my OpenPGP key: openpgp4fpr:$fingerPrint]"
echo -e "This is an OpenPGP proof that connects my OpenPGP key to this Hackernews account. For details check out https://docs.keyoxide.org/service-providers/hackernews/\n\n[Verifying my OpenPGP key: openpgp4fpr:$fingerPrint]"

read -p "Have completed this step (y/N): " keyoxidizer_response
if [ "$keyoxidizer_response" == "y" ]; then
Expand All @@ -221,7 +221,7 @@ devto()

read -p "Enter your dev.to username: " keyoxidizer_username
echo -e "Log into your dev.to account and create a new post with the following text:"
echo -e "This is an OpenPGP proof that connects [my OpenPGP key](https://keyoxide.org/$fingerPrint) to [this dev.to account](https://dev.to/$keyoxidizer_username). For details check out https://keyoxide.org/guides/openpgp-proofs\n\n[Verifying my OpenPGP key: openpgp4fpr:$fingerPrint]"
echo -e "This is an OpenPGP proof that connects [my OpenPGP key](https://keyoxide.org/$fingerPrint) to [this dev.to account](https://dev.to/$keyoxidizer_username). For details check out https://docs.keyoxide.org/service-providers/devto/\n\n[Verifying my OpenPGP key: openpgp4fpr:$fingerPrint]"

read -p "Have completed this step (y/N): " keyoxidizer_response
if [ "$keyoxidizer_response" == "y" ]; then
Expand Down
27 changes: 16 additions & 11 deletions readme.org
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ chmod +x ./keyoxidizer.sh
./keyoxidizer.sh
#+END_SRC

The releases link on Github and Codeberg will contain tagged versions with change logs. However, downloading the script from the repo root is recommended since it will be most up to date version with latest bug fix.

* Features
- Generate new key pairs
- Load existing key
Expand All @@ -28,19 +30,22 @@ chmod +x ./keyoxidizer.sh
- Delete proofs (currently requires pasting a command and typing "save" see issue 1)

* Supported Platforms
- Domain/DNS (note: sometimes DNS records take some time to update)
- Gitea
- Github
- Gitlab
- Mastodon
- Twitter
- Reddit
- Hackernews
- dev.to
1. Domain/DNS (note: sometimes DNS records take some time to update)
2. Gitea
3. Github
4. Gitlab
5. Mastodon
6. Twitter
7. Reddit
8. Hackernews
9. dev.to
10. IRC
11. Matrix

* Roadmap
- Incrementally add support for adding proofs to the [[https://keyoxide.org/guides][the different platforms]]. They will be listed under the [[Supported Platforms]] sections.
- [[https://keyoxide.org/guides/managing-proofs-listing][List]] and [[https://keyoxide.org/guides/managing-proofs-deleting][delete]] proofs
- Incrementally add support for adding proofs to [[https://docs.keyoxide.org/][the supported service providers]]. They will be listed under the [[Supported Platforms]] sections.
- +List and delete proofs+ - done but delete is a bit tedious
- Setup a build pipeline to automate releases for a tagged release.

* Contributing
I absolutely welcome feedback in the form of PRs, whether it is improving my shell scripting or adding new functionality. A few guidelines to help me out:
Expand Down

0 comments on commit ff73ee3

Please sign in to comment.