Merge pull request #17 from nicodeck/add-readme

Add README.md with installation instructions and app description
nicodeck · Jan 31, 2024 · d4f3eeb · d4f3eeb
2 parents 0b95b54 + df7c72c
commit d4f3eeb
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,36 @@
+# Done
+
+## Description
+
+Done is a simple todo list app, made for Android with React Native.
+
+Features:
+
+- create and delete todo lists
+- add, complete and delete tasks
+
+## Requirements
+
+- Node.js v18.x or higher
+- React Native CLI
+
+## Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/nicodeck/Done.git
+```
+
+2. Install dependencies:
+
+```bash
+cd Done
+yarn install
+```
+
+3. Build the app in debug mode:
+
+```bash
+yarn start
+```