From df7c72c86e99443507e5210e708a6cc7c58595b8 Mon Sep 17 00:00:00 2001 From: Nicolas Descamps Date: Wed, 31 Jan 2024 13:21:05 +0100 Subject: [PATCH] Add README.md with installation instructions and app description --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d37402a --- /dev/null +++ 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 +```