From 6cd76737807f60ba77a008e0147d5e43fbb22c4b Mon Sep 17 00:00:00 2001
From: esmagoksal <esmagoksal@gmail.com>
Date: Tue, 10 Oct 2023 15:38:30 +0100
Subject: [PATCH] Add written instructions for participants, closes #19

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

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..efe207a0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+## Welcome to Puzzyx Challenge!
+
+We are very happy to seeing you here! 
+
+==**Before starting please make sure filling your details [here](https://forms.gle/6QxSXJ7SWPtWXrP99) to join the shuffle.**==
+
+Puzzyx is a multiplatform application created by lovely Bumble developers using Appyx where we aim to
+finish a puzzle with content created by Droidcon attendees! Pick you photo or text content, add it to puzzle and 
+let it shine on our screen! ✨✨
+
+
+Here is what you need to do to create your own tile:
+- Get Familiar with [Entry](./shared/src/commonMain/kotlin/com/bumble/puzzyx/model/Entry.kt) class and its types
+- Pick the Entry type you would like to add
+- Shout out to Droidcon what you want to say
+- Or get your cool/funny photo and add it to [Resources](./shared/src/commonMain/resources/participant)
+- Create your Entry instance inside [Entries.kt](./shared/src/commonMain/kotlin/com/bumble/puzzyx/model/Entries.kt)
+- Your tile is good to go! All you need to do is create your PR and ask Bumble team for review!
+
+**Please be mindful about created content, Bumble keeps the right of rejecting a PR. 
+Any remote images,hate speech, discrimination, explicit content is not allowed.*
+
+
+## Project page
+[https://github.com/bumble-tech/puzzyx](https://github.com/bumble-tech/puzzyx)
+
+## If you want to learn more about Appyx
+
+[https://bumble-tech.github.io/appyx/](hhttps://bumble-tech.github.io/appyx/)
+
+## License
+
+<pre>
+Copyright 2023 Bumble.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+</pre>
\ No newline at end of file