From e6fe8b38c6dd1efa82cf0cbbbdad397dd3f3e1af Mon Sep 17 00:00:00 2001
From: Martin Wimpress <code@flexion.org>
Date: Wed, 5 Jul 2017 12:54:46 +0100
Subject: [PATCH] Add README.md template.

---
 README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6b088d1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+<h1 align="center">
+  <img src="https://avatars1.githubusercontent.com/u/29598503?v=3&s=256" alt="Project">
+  <br />
+  [Project]
+</h1>
+
+<p align="center"><b>This is the snap for [Project]</b>, <i>"Single-line elevator pitch for your amazing snap"</i>. It works on Ubuntu, Fedora, Debian, and other major Linux
+distributions.</p>
+
+<!-- Uncomment and modify this when you are provided a build status badge
+<p align="center">
+<a href="https://build.snapcraft.io/user/snapcrafters/fork-and-rename-me"><img src="https://build.snapcraft.io/badge/snapcrafters/fork-and-rename-me.svg" alt="Snap Status"></a>
+</p>
+-->
+
+## Install
+
+    sudo apt install snapd-xdg-open
+    sudo snap install my-snap-name
+
+([Don't have snapd installed?](https://snapcraft.io/docs/core/install))
+
+<!-- Uncomment and modify this when you have a screenshot
+![my-snap-name](screenshot.png?raw=true "my-snap-name")
+-->
+
+<p align="center">Published for <img src="http://anything.codes/slack-emoji-for-techies/emoji/tux.png" align="top" width="24" /> with :gift_heart: by Snapcrafters</p>
+
+## Remaining tasks
+
+Snapcrafters ([join us]()) 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] Fork the [Snapcrafters template](https://github.com/snapcrafters/fork-and-rename-me) repository to your own GitHub account
+  - [ ] Rename the forked Snapcrafters template repository
+  - [ ] Update logos and references to `[Project]` and `[my-snap-name]`
+  - [ ] Create a snap that runs in `devmode`
+  - [ ] Register the snap in the store, **using the preferred upstream name**
+  - [ ] Add a screenshot to this `README.md`
+  - [ ] Publish the `devmode` snap in the Snap store edge channel
+  - [ ] Add install instructions to this `README.md`
+  - [ ] Update snap store metadata, icons and screenshots
+  - [ ] Convert the snap to `strict` confinement, or `classic` confinement if it qualifies
+  - [ ] Publish the confined snap in the Snap store beta channel
+  - [ ] Update the install instructions in this `README.md`
+  - [ ] Post a call for testing on the [Snapcraft Forum](https://forum.snapcraft.io) - [link]()
+  - [ ] Request your GitHub repository is forked to the Snapcrafters organisation and configured for automated builds
+  - [ ] 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](https://forum.snapcraft.io) - [link]()
+  - [ ] Submit a pull request or patch upstream that adds snap install documentation - [link]()
+  - [ ] Submit a pull request or patch upstream that adds the `snapcraft.yaml` and any required assets/launchers - [link]()
+  - If upstream accept the PR:
+    - [ ] Request upstream create a Snap store account
+    - [ ] Add upstream contact information to the `README.md`
+    - [ ] Contact the Snap Advocacy team to request the snap be transferred to upstream
+ - [ ] Ask the Snap Advocacy team to celebrate the snap - [link]()
+
+If you have any questions, [post in the Snapcraft forum](https://forum.snapcraft.io).
+
+## The Snapcrafters
+
+| [![Your Name](http://gravatar.com/avatar/bc0bced65e963eb5c3a16cab8b004431/?s=128)](https://github.com/yourname/) |
+| :---: |
+| [Your Name](https://github.com/yourname/) |
+
+<!-- Uncomment and modify this when you have upstream contacts
+## Upstream
+
+| [![Upstream Name](http://gravatar.com/avatar/bc0bced65e963eb5c3a16cab8b004431?s=128)](https://github.com/upstreamname) |
+| :---: |
+| [Upstream Name](https://github.com/upstreamname) |
+-->
\ No newline at end of file