readme.md

README.md

@@ -1,3 +1,30 @@
-# base-spider
-
-Автоматизация графического представления структуры базы данных
+# Base spider
+    Консольная программа.
+    Паук, опрашивающий базу данных и собирающий сведения о структуре базы данных
+
+## Назначение
+    Автоматизация формирования графического представления структуры функционирующей базы данных
+
+## Область применения
+    Программа применима во всех случаях, когда есть необходимость получения графического представления базы данных:
+    - для последующей переработки структуры базы данных
+    - для разработки новых вариантов применения содержащейся в базе данных информации
+
+## Особенности реализации
+        Паук работает на платформе java.
+    В качестве драйвера, обеспечивающего взаимодействия программы с базой данных использован jdbc-driver.
+
+    Предоставляет пользователю консольный интерфейс, предусматривающий:
+        - авторизацию пользователя в системе управления базой данных по логину и паролю
+        - выбор активной базы данных
+        - выбор варианта представления отчета о функционировании базы данных
+
+    В качестве результата работы паук генерирует файл с расширением *.puml, который может быть обработан утилитой plantuml, для построения графического представления структуры базы данных.
+
+# Перспективы доработки программы
+    1. Автоматизация построения диаграмм, чтобы пользователю не нужно было самостоятельно прогонять *.puml файлы через plantuml
+    2. Автоматическое размещение диаграмм в системе контроля версий (исходников и итоговых графических схем)
+    3. Возможность аналитики не только структуры базы данных, но и самих данных
+
+<b> Все это может быть реализовано отдельными утилитами, которые будут запускаться на сервере в качестве аналитической платформы <b>
+