Merge pull request #307 from frappe/update-readme

Update README.md

Author: AyshaHakeem

README.md

@@ -1,57 +1,110 @@
-<br>
-<br>
-
 <div align="center">
-<img width="150" alt="logotype" src="https://user-images.githubusercontent.com/28212972/128001084-508e446f-2814-4e1f-a5cb-09598f5a5bdc.png">
-</div>
 
-<br>
+<img width="80" alt="wiki" src="https://github.com/user-attachments/assets/4869d211-fae2-4e93-8275-de433556feb0" />
+<h1>Frappe Wiki</h1>
 
----
+**Open Source Documentation Tool**
 
-<div align="center">
- Wiki App built on the <a href= "https://frappeframework.com" >Frappe Framework</a> | <a href = "https://wiki-docs.frappe.cloud/use_on_frappe_cloud">Try on Frappe Cloud</a>
- 
- \
- [![Wiki](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/w2jgcb/master&style=flat&logo=cypress)](https://cloud.cypress.io/projects/w2jgcb/runs)
- [![CI](https://github.com/frappe/wiki/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/frappe/wiki/actions/workflows/ci.yml)
+[![Wiki](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/w2jgcb/master&style=flat&logo=cypress)](https://cloud.cypress.io/projects/w2jgcb/runs)
+[![CI](https://github.com/frappe/wiki/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/frappe/wiki/actions/workflows/ci.yml)
+
+<img width="1470" alt="Hero Image" src="https://github.com/user-attachments/assets/ecec722d-076f-4ffa-8630-76473d1f494f" />
+
+<br />
+<br />
+<a href="https://frappe.io/wiki">Website</a>
+-
+<a href="https://docs.frappe.io/wiki/">Documentation</a>
 </div>
 
-## Introduction
+## Frappe Wiki
 
-Frappe Wiki is an Open Source [Wiki](https://en.wikipedia.org/wiki/Wiki) app built on the <a href= "https://frappeframework.com" >Frappe Framework</a>. It is well suited to serve dynamic, text-heavy content like documentation and knowledge base. It allows publishing small changes and even new pages on the fly without downtime. It also maintains revision history and has a change approval mechanism.
+Frappe Wiki is an Open Source Wiki app built on the Frappe Framework. It is well suited to serve dynamic, text-heavy content like documentation and knowledge base. It allows publishing small changes and even new pages on the fly without downtime. It also maintains revision history and has a change approval mechanism.
 
-## Installation
+<details>
+<summary>Screenshots</summary>
+<img width="1470" alt="EditvPage" src="https://github.com/user-attachments/assets/33ff0704-0f5e-4e9a-8e59-5f50cd8b664c" />
+</details>
 
-```bash
-# get app
-$ bench get-app https://github.com/frappe/wiki
 
-# install on site
-$ bench --site sitename install-app wiki
-```
+### Motivation
+
+Frappe Wiki, like many of our products was developed for our own needs. We were looking for a simple, clean, open source wiki to write documentation for ERPNext, but due to a lack of good options, we decided to write our own from scratch!
+
+Our goal was clear: create an open-source wiki that provides a delightful experience for writers and readers. Today, we use Frappe Wiki for all sorts of internal things – user manuals, company policies, you name it! The easy-to-use interface and simple editing features make it perfect for anyone on our team.
+
+
+### Key Features
 
-> [!NOTE]  
-> Use `version-14` branch with Frappe Framework v14 and for v14+ use `master` branch.
+- **Create Wiki Pages**: Easily create and organize wiki pages to manage and share knowledge systematically.
+Author Content in Markdown: Write and format content effortlessly using Markdown syntax, ensuring a clean and readable structure.
+- **Set-up Controlled Wiki Updates**: Implement workflows to review and approve edits before publishing, ensuring content accuracy and consistency.
+- **Add Attachments**: Attach relevant files and documents directly to wiki pages for better context and resource sharing.
+- **Table of Contents**: Automatically generate a navigable table of contents for enhanced readability and structure.
+- **Custom Script Support via Wiki Settings**: Customize wiki behavior and extend functionality using custom scripts configured in Wiki Settings.
 
-## Features
+### Under the Hood
 
-1. Create Wiki Pages
-2. Author content in Rich Text
-3. Set-up Controlled Wiki Updates
-5. Add attachments
-6. Table of Contents
-7. Caching
-8. Custom Script Support via `Wiki Settings`
+- [**Frappe Framework**](https://github.com/frappe/frappe): A full-stack web application framework.
 
-## Screenshots
+- [**Ace Editor**](https://github.com/ajaxorg/ace): Ace is an embeddable code editor written in JavaScript.
 
-### 1. Rendered Page
-<img width="1552" alt="wiki-rendered" src="https://github.com/frappe/wiki/assets/63963181/011e976e-b572-4d3a-82e8-374d26ecd0d0.png">
+- [**RedisSearch**](https://github.com/RediSearch/RediSearch): A powerful search and indexing engine built on top of Redis.
 
-### 2. Edit Page
-<img width="1552" alt="wiki-edit" src="https://github.com/frappe/wiki/assets/63963181/339d1422-6c99-450d-9e97-7348651abe63.png">
+## Production Setup
+
+### Managed Hosting
+
+You can try [Frappe Cloud](https://frappecloud.com), a simple, user-friendly and sophisticated [open-source](https://github.com/frappe/press) platform to host Frappe applications with peace of mind.
+
+It takes care of installation, setup, upgrades, monitoring, maintenance and support of your Frappe deployments. It is a fully featured developer platform with an ability to manage and control multiple Frappe deployments.
+
+<div>
+    <a href="https://frappecloud.com/marketplace/apps/wiki" target="_blank">
+        <picture>
+            <source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/try-on-fc-white.png">
+            <img src="https://frappe.io/files/try-on-fc-black.png" alt="Try on Frappe Cloud" height="28" />
+        </picture>
+    </a>
+</div>
 
-#### License
+## Development Setup
 
-MIT
+
+### Local
+
+To setup the repository locally follow the steps mentioned below:
+
+1. Setup bench by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation) and start the server
+
+```
+bench start
+```
+
+2. In a separate terminal window, cd into `frappe-bench` directory and run the following commands:
+
+```
+# get app
+$ bench get-app https://github.com/frappe/wiki
+
+# install on site
+$ bench --site sitename install-app wiki
+
+```
+
+## Learn and connect
+- [Telegram Public Group](https://t.me/frappewiki)
+- [Discuss Forum](https://discuss.frappe.io/c/wiki/72)
+- [Documentation](https://docs.frappe.io/wiki/)
+- [YouTube](https://www.youtube.com/@frappetech)
+
+<br>
+<br>
+<div align="center" style="padding-top: 0.75rem;">
+    <a href="https://frappe.io" target="_blank">
+        <picture>
+            <source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/Frappe-white.png">
+            <img src="https://frappe.io/files/Frappe-black.png" alt="Frappe Technologies" height="28"/>
+        </picture>
+    </a>
+</div>