From f6c328487437305f9acda300bf0ffb26437af37e Mon Sep 17 00:00:00 2001
From: "tomasz.kasprowicz" <tomasz.kasprowicz@rsqtechnologies.com>
Date: Sat, 16 Jan 2021 19:38:48 +0100
Subject: [PATCH] added readme

---
 README.md | 74 +++++++++++++++++++++++++++----------------------------
 1 file changed, 37 insertions(+), 37 deletions(-)

diff --git a/README.md b/README.md
index b58e0af..b9c6921 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,46 @@
-# Getting Started with Create React App
+# ToDo App
+> Aplikacja internetowa dostarczająca możliwość zapisu zadań do wykonania w określonym terminie. Liczne zakładki z możliwością wglądu do już wykonanych zadań jak I do nadchodzących, oznaczonych jako ważne bądź z przypisaną kategorią np.biznesową..
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
-## Available Scripts
+## Table of contents
+* [General info](#general-info)
+* [Technologies](#technologies)
+* [Setup](#setup)
+* [Status](#status)
 
-In the project directory, you can run:
+## General info
+App was created for learning purpose.
 
-### `yarn start`
+## Technologies
+* React.js
+* Redux
+* React-router
+* Styled-Components
+* FIREBASE
+* bootstrap
+* dayjs
+* typescript
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+## Setup
+1. clone repo   
+```
+git clone https://git.wmi.amu.edu.pl/s449311/todo-list.git
+```
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+2. cd TODO-LIST  
+```
+cd TODO-LIST  
+```
 
-### `yarn test`
+3. install dependencies using npm 
+```
+npm i
+```
+3. To start server
+```
+npm start
+```
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+## Status
+Project is: finished.
 
-### `yarn build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).