aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fc6dd8c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Discourse Sample Plugin
+
+This is a plugin I'm making to learn how these work, following the
+official tutorials.
+
+## Beginner's Guide to Creating a Discourse Plugin
+
+- Part 1: [Creating a basic plugin][part1]
+- Part 2: [Plugin outlets][part2]
+- Part 3: [Custom Settings][part3]
+- Part 4: [git setup][part4]
+- Part 5: [Admin interfaces][part5]
+- Part 6: [Acceptance Tests][part6]
+
+[part1]: https://meta.discourse.org/t/beginners-guide-to-creating-discourse-plugins-part-1/30515
+[part2]: https://meta.discourse.org/t/beginners-guide-to-creating-discourse-plugins-part-2-plugin-outlets/31001
+[part3]: https://meta.discourse.org/t/beginners-guide-to-creating-discourse-plugins-part-3-custom-settings/31115
+[part4]: https://meta.discourse.org/t/beginners-guide-to-creating-discourse-plugins-part-4-git-setup/31272
+[part5]: https://meta.discourse.org/t/beginners-guide-to-creating-discourse-plugins-part-5-admin-interfaces/31761
+[part6]: https://meta.discourse.org/t/beginner-s-guide-to-creating-discourse-plugins-part-6-acceptance-tests/32619
+
+## Setting Up the Development Environment
+
+See [Discourse as Your First Rails App](https://blog.discourse.org/2013/04/discourse-as-your-first-rails-app/).
+