Updated readme with components to do

ctidigital · Sep 14, 2016 · 013ee84 · 013ee84
1 parent 044658a
commit 013ee84
Showing 1 changed file with 50 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,6 +2,16 @@
 
 [![Build Status](https://travis-ci.org/ctidigital/magento2-configurator.svg?branch=develop)](https://travis-ci.org/ctidigital/magento2-configurator)
 
+
+A Magento module initially created by [CTI Digital] to create and maintain database variables using files. This module aims to bring the following benefits to a Magento developer's work flow:
+
+  - Install Magento from scratch with important database based configuration ready.
+  - Share and collaborate configuration with other colleagues using your own versioning system.
+  - Keep versions of your configurations using your own versioning system.
+  - Split your configuration based on the environment you're developing on.
+
+If you're interested about finding out more about the background of the configurator, watch this lightning talk by [Rick Steckles] at Mage Titans in Manchester on [YouTube].
+
 This is a work in progress and by no means for use with production environments (and probably not even development environments either just yet).
 
 ## Testing Locally For Development
@@ -12,4 +22,43 @@ php vendor/bin/phpcs --standard=PSR2 vendor/ctidigital/magento2-configurator/Mod
 php vendor/bin/phpmd vendor/ctidigital/magento2-configurator/Model/,vendor/ctidigital/magento2-configurator/Console/,vendor/ctidigital/magento2-configurator/Test/ text cleancode,codesize,controversial,design,naming,unusedcode
 php vendor/bin/phpcpd vendor/ctidigital/magento2-configurator/Model/ vendor/ctidigital/magento2-configurator/Console vendor/ctidigital/magento2-configurator/Test/
 php vendor/bin/phpunit --coverage-clover build/logs/clover.xml vendor/ctidigital/magento2-configurator/Test/Unit/
-```
+```
+
+## Roadmap for components to do
+
+| Component                 | Code Written       | Tests Written | Sample Files       |
+|---------------------------|--------------------|---------------|--------------------|
+| Websites                  | :white_check_mark: | :x:           | :white_check_mark: |
+| System Configuration      | :white_check_mark: | :x:           | :white_check_mark: |
+| Attribute Sets            | :x:                | :x:           | :x:                |
+| Attributes                | :x:                | :x:           | :x:                |
+| Categories                | :x:                | :x:           | :x:                |
+| Products                  | :x:                | :x:           | :x:                |
+| Admin Roles               | :x:                | :x:           | :x:                |
+| Admin Users               | :x:                | :x:           | :x:                |
+| Pages                     | :x:                | :x:           | :x:                |
+| Static Blocks             | :x:                | :x:           | :x:                |
+| Customers                 | :x:                | :x:           | :x:                |
+| Media                     | :x:                | :x:           | :x:                |
+| Widgets                   | :x:                | :x:           | :x:                |
+| Related Products          | :x:                | :x:           | :x:                |
+| SQL                       | :x:                | :x:           | :x:                |
+| Customer Groups           | :x:                | :x:           | :x:                |
+| Tax Rules                 | :x:                | :x:           | :x:                |
+| API Roles                 | :x:                | :x:           | :x:                |
+| API Users                 | :x:                | :x:           | :x:                |
+| Shipping Table Rates      | :x:                | :x:           | :x:                |
+| Catalog Price Rules       | :x:                | :x:           | :x:                |
+| Shopping Cart Price Rules | :x:                | :x:           | :x:                |
+| Rewrites                  | :x:                | :x:           | :x:                |
+| Orders                    | :x:                | :x:           | :x:                |
+
+License
+----
+
+MIT
+
+
+[CTI Digital]:http://www.ctidigital.com/
+[YouTube]:https://www.youtube.com/watch?v=u9zHaX8G5_0
+[Rick Steckles]:https://twitter.com/rick_steckles