Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pedro-avalos committed Dec 15, 2024
1 parent 97b1d76 commit 47c9535
Showing 1 changed file with 2 additions and 39 deletions.
41 changes: 2 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
</h1>

<p align="center"><b>This is the snap for <a href="https://proton.me/mail/bridge">Proton Mail Bridge</a></b>,
<i>Proton Mail Bridge is a desktop application that runs in the background,
encrypting and decrypting messages as they enter and leave your computer</i>.
<i>"Proton Mail Bridge is a desktop application that runs in the background,
encrypting and decrypting messages as they enter and leave your computer"</i>.
It works on Ubuntu, Fedora, Debian, and other major Linux distributions.</p>

<p align="center">
Expand Down Expand Up @@ -43,43 +43,6 @@ plug.
sudo snap connect protonmail-bridge:password-manager-service
```

## Remaining tasks

Snapcrafters ([join us](https://forum.snapcraft.io/t/snapcrafters-reboot/24625)) are working to land snap install documentation and the [snapcraft.yaml](https://github.com/snapcrafters/fork-and-rename-me/blob/master/snap/snapcraft.yaml) upstream so [Project] can authoritatively publish future releases.

- [x] Click the green "Use this template" button above to create a new repository based on this template
- [X] Give the newly created repository a sensible name, like `godzilla` if you're snapping the Godzilla software (*Note: Do not use `snap` in this name.*)
- [X] Update the description of the repository to `Unofficial snap for [Project]`
- [X] Update logos and references to `[Project]` and `[my-snap-name]`
- [X] Create a snap that runs in `devmode`
- [X] Convert the snap to `strict` confinement, or `classic` confinement if it qualifies
- [X] Register the snap in the store, **using the preferred upstream name**
- [X] Add a screenshot to this `README.md`
- [X] Add install instructions to this `README.md`
- [x] Update snap store metadata, icons and screenshots
- [X] Publish the confined snap in the Snap store beta channel
- [X] Update the install instructions in this `README.md`
- [X] Post a call for testing in the Snapcraft Forum ["Snapcrafters" category](https://forum.snapcraft.io/c/snapcrafters/23) - [link](https://forum.snapcraft.io/t/call-for-testing-protonmail-bridge/43421?u=pedro-avalos)
- [X] Add the Snapcraft store account (snap-advocacy@canonical.com) as a collaborator to your snap in the [Dashboard](https://dashboard.snapcraft.io) and ask a [Snapcrafters admin](https://github.com/orgs/snapcrafters/people?query=%20role%3Aowner) to accept this request
- [ ] Fix all important issues found during testing
- [ ] Make a post in the Snapcraft Forum ["store-requests" category](https://forum.snapcraft.io/c/store-requests/19) asking for a transfer of the snap name from you to Snapcrafters - [link]()
- [ ] Ask a [Snapcrafters admin](https://github.com/orgs/snapcrafters/people?query=%20role%3Aowner) to fork your repo into github.com/snapcrafters, and configure the repo for automatic publishing into edge on commit
- [ ] Add the provided Snapcraft build badge to this `README.md`
- [ ] Publish the snap in the Snap store stable channel
- [ ] Update the install instructions in this `README.md`
- [ ] Post an announcement in the Snapcraft Forum ["Snapcrafters" category](https://forum.snapcraft.io/c/snapcrafters/23) - [link]()
- [ ] Ask the Snap Advocacy team to celebrate the snap - [link]()
- [ ] Submit a pull request or patch upstream that adds snap install documentation - [link]()
- [ ] Ask upstream if they are interested in maintaining the Snap. If they are:
- [ ] Fork the upstream project, add the snap build files and required assets/launchers to that repo and submit a pull request or patch - [link]()
- [ ] Add upstream contact information to the `README.md`
- If upstream accept the PR:
- [ ] Request upstream create a Snap store account
- [ ] Add upstream account as a collaborator on the snap
- [ ] Contact the Snap Advocacy team to request the snap be transferred to upstream

If you have any questions, [post in the Snapcraft forum](https://forum.snapcraft.io).

## The Snapcrafters

| [![Pedro Avalos Jimenez](https://gravatar.com/avatar/99d80a655179643de6d2b8eccad0b12a16b21d778a5c2676ed9ab7dcaa0d889c/?s=128)](https://github.com/pedro-avalos/) |
Expand Down

0 comments on commit 47c9535

Please sign in to comment.