feat: first alpha version

.gitignore

@@ -28,6 +28,10 @@ coverage
 
 # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
+data/
+steps/
+cleaned_data/
+log.txt
 
 # Bower dependency directory (https://bower.io/)
 bower_components

README.md

@@ -1,2 +1,35 @@
 # Data-cleaning
+
 A tool for cleaning datasets from turing ai
+
+# Usage guide
+
+1. Clone the repository
+
+```
+git clone https://github.com/TuringAI-Team/Data-cleaning.git
+```
+
+2. Install the requirements
+
+```
+npm install
+```
+
+3. Create folders, where you will store your datasets and results
+   Create a folder in root called data
+   Create a folder in root called steps
+4. Export your dataset from turing ai to the data folder and name it data.csv
+5. Run the CLI
+
+```
+npm run dev
+```
+
+6. Follow the instructions in the CLI
+7. The results will be stored in the steps folder
+
+# To do
+
+- [ ] Fix bug where sometimes it answer with invalid json
+- [ ] Improve cleaning to not remove so much data