update

Author: HMarzban

README.md

@@ -1,19 +1,36 @@
-<div class="Box-body px-5 pb-5">
-        <article class="markdown-body entry-content container-lg" itemprop="text"><h1><a id="user-content-docsplus" class="anchor" aria-hidden="true" href="#docsplus"><svg class="octicon octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z"></path></svg></a>docs.plus</h1>
-<p><strong>docs.plus is a tool to help communites share knowledge</strong></p>
-<p>It is the result of over six years of research by <a href="https://newspeak.house" rel="nofollow">newspeak.house</a> into civil society and public sector coordination and crisis response.
-It solves many common organising problems, and can be frictionlessly adopted by all typical stakeholders without needing any training.</p>
-<p>docs.plus intuitively combines all the common communication tools:</p>
-<ul>
-<li><g-emoji class="g-emoji" alias="white_check_mark" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/2705.png"><img class="emoji" alt="white_check_mark" height="20" width="20" src="https://github.githubassets.com/images/icons/emoji/unicode/2705.png"></g-emoji> collaborative documents</li>
-<li><g-emoji class="g-emoji" alias="white_check_mark" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/2705.png"><img class="emoji" alt="white_check_mark" height="20" width="20" src="https://github.githubassets.com/images/icons/emoji/unicode/2705.png"></g-emoji> videocalls (with unlimited self-organising breakout rooms)</li>
-<li><g-emoji class="g-emoji" alias="white_check_mark" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/2705.png"><img class="emoji" alt="white_check_mark" height="20" width="20" src="https://github.githubassets.com/images/icons/emoji/unicode/2705.png"></g-emoji> group text chat</li>
-<li><g-emoji class="g-emoji" alias="soon" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png"><img class="emoji" alt="soon" height="20" width="20" src="https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png"></g-emoji> email subscription</li>
-<li><g-emoji class="g-emoji" alias="soon" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png"><img class="emoji" alt="soon" height="20" width="20" src="https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png"></g-emoji> native mobile app (push notifications)</li>
-<li><g-emoji class="g-emoji" alias="soon" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png"><img class="emoji" alt="soon" height="20" width="20" src="https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png"></g-emoji> search, filtering and tagging</li>
-</ul>
-
-Docs.plus is built on [Etherpad](https://github.com/ether/etherpad-lite) with some modification and a set of custom plugins:
+[![Generic badge](https://img.shields.io/badge/version-1.8.12-<COLOR>.svg)](https://docs.plus)
+[![MIT license](https://img.shields.io/badge/License-Apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/nwspk/docs.plus)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://github.com/nwspk/docs.plus/compare)
+[![All Contributors](https://img.shields.io/badge/all_contributors-4-blue.svg)](#contributors-)
+
+
+# 📚 Docs.plus
+
+**Docs.plus** is a real-time collaborative tools to help communites share knowledge
+
+## About
+
+It is the result of over six years of research by [newspeak.house](https://newspeak.house) into civil society and public sector coordination and crisis response.
+It solves many common organising problems, and can be frictionlessly adopted by all typical stakeholders without needing any training.
+
+**Docs.plus** intuitively combines all the common communication tools:
+
+- ✔️ Collaborative documents
+- ✔️ Videocalls (with unlimited self-organising breakout rooms)
+- ✔️ Group text chat
+- 🚧 Profiling
+- ⏭️ Email subscription
+- ⏭️ Search, filtering and tagging
+- ⏭️ Mobile and desktop app
+- ⏭️ Push notifications
+- *Suggest the next feature...*
+
+# Base
+
+**Docs.plus** is built on [Etherpad](https://github.com/ether/etherpad-lite) which is a real-time collaborative editor for the web, our team tweek a etherpad bases for the goal we persude, also we are using combanation of etherpad plugin and custom one to power up our goals.
+
+### Plugins
 
 - [ep_wrtc_heading](https://github.com/HMarzban/ep_wrtc_heading)
 - [ep_insert_media](https://github.com/samirsayyad/ep_insert_media)
@@ -32,6 +49,67 @@ Docs.plus is built on [Etherpad](https://github.com/ether/etherpad-lite) with so
 - [ep_remove_embed](https://github.com/tjwelde/ep_remove_embed)
 - [ep_sticky_attributes](https://github.com/JohnMcLear/ep_sticky_attributes)
 
-# License
+# 🚀 Prerequisites & Installation
+Prerequisites and installation are the same as Etherpad flow, follow this [link](https://github.com/ether/etherpad-lite#installation), or you can follow short steps like the following:
+
+```bash
+# clone the project
+git clone https://github.com/nwspk/docs.plus.git
+
+# move to the project folder
+cd docsplus
+
+# install pre requirement plugins
+npm install --no-save --legacy-peer-deps
+        ep_adminpads2
+        ep_remove_embed
+        ep_hide_line_numbers
+        ep_monetization
+        https://github.com/samirsayyad/ep_custom_header_message
+        https://github.com/samirsayyad/ep_bottom_chat_bar
+        https://github.com/ether/ep_comments_page
+        https://github.com/ether/ep_cursortrace
+        https://github.com/samirsayyad/ep_docs_plus_customize#c68bc28
+        https://github.com/samirsayyad/ep_full_hyperlinks#ce24888
+        https://github.com/samirsayyad/ep_headings2#f88ac17
+        https://github.com/samirsayyad/ep_insert_media#35b26c5
+        https://github.com/samirsayyad/ep_loading_pad#84a888f
+        https://github.com/samirsayyad/ep_profile_modal#eb3bb71
+        https://github.com/samirsayyad/ep_set_title_on_pad#b1688b0
+        https://github.com/samirsayyad/ep_table_of_contents#326ccfc
+        https://github.com/HMarzban/ep_wrtc_heading#1fd4e08
+        https://github.com/ether/ep_sticky_attributes.git
+
+# run the docsplus
+src/bin/run.sh
+```
+> For mor info Take a look at [CI](https://github.com/nwspk/docs.plus/blob/master/.github/workflows/master.yml)
+
+> If you wanna have your Turn/Stun server for the video chat you can follow this installation for the [Coturn](https://github.com/coturn/coturn) server; [Link](https://dev.to/kevin_odongo35/how-to-configure-a-turn-server-3opd). <br>*By default, the video plugin uses a public Stun server [More info](https://github.com/HMarzban/ep_wrtc_heading)*
+
+# 🤝 Contributing
+Thank you for your interest in contributing! Please feel free to put up a PR for any issue or feature request.
+
+### ✨ Contributors 
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+|  |  |  |  |
+| --------- | ------ | ----------- | ------------- |
+| [<img src="https://avatars.githubusercontent.com/u/5703915?v=4?s=100" width="100"><br> 📆💼 edsaperia](https://github.com/edsaperia) | [<img src="https://avatars.githubusercontent.com/u/11405614?v=4?s=100" width="100"><br>💻🚇 samirsayyad](https://github.com/samirsayyad)  | [<img src="https://avatars.githubusercontent.com/u/20157508?v=4?s=100" width="100"><br>💻🚇Hossein](https://github.com/HMarzban)  | [<img src="https://avatars.githubusercontent.com/u/1060378?v=4?s=100" width="100"><br>🚇Josh Balfour](https://github.com/joshbalfour)  |
+
+
+# 👋 Contact
+If you have any further questions, please don’t hesitate, you can reach us by the following:
+- Twitter: [@docsdotplus](https://twitter.com/docsdotplus)
+- Github: [docs.plus](https://github.com/nwspk/docs.plus)
+- Slack: [docsplus](docsplus.slack.com)
+- Email: [contact@newspeak.house](mailto:contact@newspeak.house)
+
+# 📝 License
+This project is licensed under the [Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html) License
+
+# Support
+**Docs.plus** is free and open source, please help us stay online:
+
+<a href="https://patreon.com/docsplus"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Ddocsplus%26type%3Dpatrons&style=for-the-badge" /> </a>
 
-[Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html)