keep-starknet-strange · apoorvsadana · Aug 18, 2023 · Aug 18, 2023
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -0,0 +1,49 @@
+{
+  "projectName": "madara-tsukuyomi",
+  "projectOwner": "keep-starknet-strange",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": ["README.md"],
+  "imageSize": 100,
+  "commit": true,
+  "commitConvention": "gitmoji",
+  "contributors": [
+    {
+      "login": "abdelhamidbakhta",
+      "name": "Abdel @ StarkWare ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/45264458?v=4",
+      "profile": "https://github.com/abdelhamidbakhta",
+      "contributions": ["code"]
+    },
+    {
+      "login": "apoorvsadana",
+      "name": "Apoorv Sadana",
+      "avatar_url": "https://avatars.githubusercontent.com/u/95699312?v=4",
+      "profile": "https://github.com/apoorvsadana",
+      "contributions": ["code"]
+    },
+    {
+      "login": "ayushtom",
+      "name": "Ayush Tomar",
+      "avatar_url": "https://avatars.githubusercontent.com/u/41674634?v=4",
+      "profile": "https://github.com/ayushtom",
+      "contributions": ["code"]
+    },
+    {
+      "login": "d-roak",
+      "name": "Oak",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5263301?v=4",
+      "profile": "https://droak.sh/",
+      "contributions": ["code"]
+    },
+    {
+      "login": "rkdud007",
+      "name": "Pia",
+      "avatar_url": "https://avatars.githubusercontent.com/u/76558220?v=4",
+      "profile": "https://github.com/rkdud007",
+      "contributions": ["code"]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "linkToUsage": false
+}
diff --git a/.github/ISSUE_TEMPLATE/1-Bug_report.md b/.github/ISSUE_TEMPLATE/1-Bug_report.md
@@ -4,18 +4,6 @@ about: You're having technical issues. 🐞
 labels: 'bug'
 ---
 
-<!-- Please use the following issue template or your issue will be closed -->
-
-## Prerequisites
-
-<!-- If the following boxes are not ALL checked, your issue is likely to be closed -->
-
-- [ ] Using npm
-- [ ] Using an up-to-date [`main` branch](https://github.com/electron-react-boilerplate/electron-react-boilerplate/tree/main)
-- [ ] Using latest version of devtools. [Check the docs for how to update](https://electron-react-boilerplate.js.org/docs/dev-tools/)
-- [ ] Tried solutions mentioned in [#400](https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues/400)
-- [ ] For issue in production release, add devtools output of `DEBUG_PROD=true npm run build && npm start`
-
 ## Expected Behavior
 
 <!--- What should have happened? -->
@@ -55,13 +43,3 @@ labels: 'bug'
 - electron-react-boilerplate version or branch :
 - Operating System and version :
 - Link to your project :
-
-<!---
-❗️❗️ Also, please consider donating (https://opencollective.com/electron-react-boilerplate-594) ❗️❗️
-
-Donations will ensure the following:
-
-🔨 Long term maintenance of the project
-🛣 Progress on the roadmap
-🐛 Quick responses to bug reports and help requests
- -->
diff --git a/.github/ISSUE_TEMPLATE/2-Question.md b/.github/ISSUE_TEMPLATE/2-Question.md
@@ -7,13 +7,3 @@ labels: 'question'
 ## Summary
 
 <!-- What do you need help with? -->
-
-<!---
-❗️❗️ Also, please consider donating (https://opencollective.com/electron-react-boilerplate-594) ❗️❗️
-
-Donations will ensure the following:
-
-🔨 Long term maintenance of the project
-🛣 Progress on the roadmap
-🐛 Quick responses to bug reports and help requests
- -->
diff --git a/.github/ISSUE_TEMPLATE/3-Feature_request.md b/.github/ISSUE_TEMPLATE/3-Feature_request.md
@@ -4,12 +4,29 @@ about: You want something added to the boilerplate. 🎉
 labels: 'enhancement'
 ---
 
-<!---
-❗️❗️ Also, please consider donating (https://opencollective.com/electron-react-boilerplate-594) ❗️❗️
+## Feature Request
 
-Donations will ensure the following:
+**Describe the Feature Request**
 
-🔨 Long term maintenance of the project
-🛣 Progress on the roadmap
-🐛 Quick responses to bug reports and help requests
- -->
+<!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. -->
+
+**Describe Preferred Solution**
+
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe Alternatives**
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Related Code**
+
+<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
+
+**Additional Context**
+
+<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. -->
+
+**If the feature request is approved, would you be willing to submit a PR?**
+_(Help can be provided if you need assistance submitting a PR)_
+
+<!-- Yes or  No -->
diff --git a/README.md b/README.md
@@ -1,5 +1,43 @@
-# madara-tsukuyomi
-Madara Desktop Application 
+
+<div align="center">
+  <img src="docs/assets/sharingan_eye.png" height="250">
+</div>
+
+<div align="center">
+<br />
+
+[![Project license](https://img.shields.io/github/license/keep-starknet-strange/madara.svg?style=flat-square)](LICENSE)
+[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/keep-starknet-strange/madara/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
+<a href="https://twitter.com/MadaraStarknet">
+<img src="https://img.shields.io/twitter/follow/MadaraStarknet?style=social"/>
+</a> <a href="https://github.com/keep-starknet-strange/madara-tsukuyomi">
+<img src="https://img.shields.io/github/stars/keep-starknet-strange/madara-tsukuyomi?style=social"/>
+</a>
+</div>
+
+# Madara Tsukuyomi
+
+Madara Tsukuyomi is a one click desktop application that allows anyone (even your grandmother) to start a Madara node with just a click.
+
+## Features
+
+1. Enter your name and deploy a node! An identity is all you need to start running your Madara node
+2. Connect to [sharingan](https://github.com/keep-starknet-strange/madara/blob/main/docs/sharingan-starter-pack.md#what-is-sharingan) and configure other settings of the node
+3. See the logs of the node in realtime
+4. Install dockerized/binary apps that allow you to interact with your node.
+
+## Running Tsukuyomi
+
+Tsukuyomi is an electron app. You can start it as follows
+
+```bash
+npm install
+npm run start
+```
+
+## Demo
+
+You can watch a demo of what we built till the Starknet Hacker House in Paris over [here](https://www.youtube.com/live/skyYpU0xjdc?feature=share&t=19640). However, keep in mind that this video will get outdated with time as we keep adding new features.
 
 ## Sign & Notarize Setup
 
@@ -16,4 +54,30 @@ xcrun notarytool store-credentials kss
 ***sign app***
 ```sh
 DEBUG=electron-osx-sign* CI=true npm run package
-```
+```
+
+## Contributors ✨
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/abdelhamidbakhta"><img src="https://avatars.githubusercontent.com/u/45264458?v=4?s=100" width="100px;" alt="Abdel @ StarkWare "/><br /><sub><b>Abdel @ StarkWare </b></sub></a><br /><a href="https://github.com/keep-starknet-strange/madara/commits?author=abdelhamidbakhta" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/apoorvsadana"><img src="https://avatars.githubusercontent.com/u/95699312?v=4?s=100" width="100px;" alt="apoorvsadana"/><br /><sub><b>apoorvsadana</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/madara/commits?author=apoorvsadana" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ayushtom"><img src="https://avatars.githubusercontent.com/u/41674634?v=4" width="100px;" alt="ayushtom"/><br /><sub><b>ayushtom</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/madara/commits?author=ayushtom" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://droak.sh/"><img src="https://avatars.githubusercontent.com/u/5263301?v=4?s=100" width="100px;" alt="Oak"/><br /><sub><b>Oak</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/madara/commits?author=d-roak" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/rkdud007"><img src="https://avatars.githubusercontent.com/u/76558220?v=4?s=100" width="100px;" alt="Pia"/><br /><sub><b>Pia</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/madara/commits?author=rkdud007" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the
+[all-contributors](https://github.com/all-contributors/all-contributors)
+specification. Contributions of any kind welcome!
diff --git a/docs/assets/sharingan_eye.png b/docs/assets/sharingan_eye.png