From d65a27b222fd841bb69a301aaa658b56b9067f71 Mon Sep 17 00:00:00 2001 From: ChristopherBarroso <101362339+ChristopherBarroso@users.noreply.github.com> Date: Mon, 12 Feb 2024 13:35:15 -0500 Subject: [PATCH] Updated README.md To Include Features Changed the Following: -Added features that are available when creating a flow chart -Talked about creating an account to save data -Introduced Flowchart Fun Pro -Described Different Language Translations Provided by Flowchart Fun -Further Described Technologies behind Flowchart Fun --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index e1ef3a98c..4eec2c16c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,20 @@ screenshot +## Features + +Flowchart Fun is actively working on implementing new and innovative features! Some of are features include: + -Editing with AI + -Importing Data + -Variety of Templates + -Importing Data + -Different Themes + -10 Layout Designs + -Different Background Colors + -Different Node Shapes and Colors + -Log In to Save Your Charts! Creating An Account is Quick and Easy! + -Try Out FlowChart Fun Pro For a Variety of Premium Features! + ## 📝 Example For an example of how Flowchart Fun works, take the following input: @@ -21,8 +35,17 @@ You can generate this flowchart with just a few clicks: ## 🛠️ Development +Before making a contribution to Flowchart Fun, you should know a little bit about the technologies we're using. +After that, you should be ready to help out! + Flowchart Fun is built with [React](https://reactjs.org/) and [cytoscape.js](https://github.com/cytoscape/cytoscape.js). +-**React:** A JavaScript library for building dynamic user interfaces based on components. + -Want to familiarize yourself with React? Read the official React documentation (https://reactjs.org/docs/getting-started.html) + to learn more. +-**Cytoscape:** CytoScape is a Graph theory (network) library for visualisation and analysis. + -Learn more about Cytoscape on its offical website (https://js.cytoscape.org/#introduction/factsheet). + ### 💡 Prerequisites If you plan on developing the premium features, you will need accounts on [Vercel](https://vercel.com/docs/concepts/functions/introduction), [Supabase](https://supabase.io/), [Stripe](https://stripe.com/) and [Sendgrid](https://sendgrid.com/). @@ -45,6 +68,16 @@ Note: You will need to create a [Vercel account](https://vercel.com/signup) and ### 🌐 Translations +Flowchart Fun is available in a variety of languages: +-Deutsch +-English +-Español +-Fançais +-हिन्दी +-한국어 +-Português +-中文 + We welcome anyone interested in helping us add translations to Flowchart Fun. Translations can be added to the .po files located in /app/src/locales/[language]/messages.po. After adding translations, please run `pnpm -F app compile`. We would appreciate your help in making Flowchart Fun accessible in even more languages! #### 💬 Interested in Adding a Language?