further API simplification

[javainspect.git] / doc / index.org

diff --git a/doc/index.org b/doc/index.org
index 8ec6dcb..1751f8d 100644 (file)
--- a/doc/index.org
+++ b/doc/index.org
@@ -1,13 +1,18 @@
 #+TITLE: JavaInspect - Utility to visualize java software
 
 -----
+- [[http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]]
+
+- This program is free software; you can redistribute it and/or modify
+  it under the terms of version 3 of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public
+  License]] or later as published by the Free Software Foundation.
 
-- [[http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz][download]]
-- [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
 - Program author:
-    - Svjatoslav Agejenko
-    - Homepage: http://svjatoslav.eu
-    - Email: mailto://svjatoslav@svjatoslav.eu
+  - Svjatoslav Agejenko
+  - Homepage: http://svjatoslav.eu
+  - Email: mailto://svjatoslav@svjatoslav.eu
+
+- [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
 
 * General
 Goal: simplify/speed up understanding the computer program code by
@@ -126,3 +131,25 @@ Add Maven repository to retrieve artifact from:
 
 On Ubuntu/Debian use:
 : sudo apt-get install graphviz
+* TODO
+- BUG: Should not hide references if there are too many of them to
+  classes if referring classes are not visible anyway because of
+  blacklist/whitelist rules. Basically reference counting should
+  exclude not visible classes.
+- BUG: Current code is quite messy (because of lack of time) things
+  were implemented ad-hoc. Needs cleanup/refactoring for better
+  readability.
+- FEATURE: add dark theme
+- FEATURE: sort Class fields by alphabet
+- FEATURE: visualize also concrete field values so it could be used as
+  ultra cool runtime logging framework
+- FEATURE: possibility to visualize structure and data from JVM
+  snapshot
+- FEATURE: possibility to attach to remote process to visualize
+  data/structure using JVM debug port and mechanism.
+- FEATURE: possibility to attach to JVM using JVM agent
+- FEATURE: possibility to script javainspect behavior
+- FEATURE: possibility to select classes/fields/values to be
+  visualized in SQL like syntax
+- FEATURE: configurable maven plugin to generate graphs as part of the
+  project build/release process