status-im
/
re-frame-10x
mirror of https://github.com/status-im/re-frame-10x.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Mike Thompson 2018-02-11 17:50:13 +11:00 committed by GitHub
parent 8b6874b4f8
commit cbf40ee120
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -20,8 +20,8 @@ aspect of what `re-frame-trace` delivers.
### It Is About Trace Data
As it runs, `re-frame` logs "trace" as data (not strings).
This data trace provides an x-ray of your app's functioning.
As it runs, `re-frame` logs "trace" as data (not strings).
And this data trace provides an x-ray of your app's functioning.
`re-frame-trace` is essentially a consumer, processor and displayer of this x-ray trace data.
@ -39,10 +39,11 @@ So, data is at the core of `re-frame-trace` in both of the ways just described,
and that should not be the slightest bit surprising.
Each time you put a `println` into your program,
you are printing out what? And why? Data is the fuel of your debugging investigation.
you are printing out what? And why? Data is the fuel of your debugging investigation.
Have you seen LightTable? It was attractive because it co-renders data and
code. The data presented is the "paper trail" by which you can percieve the dynamics of the code.
code. The data presented is the "paper trail" by which you can better percieve
the dynamics of the code.
### It Is A Data Dashboard
@ -80,11 +81,12 @@ Deeper knowledge is the goal. Easier debugging is the symptom.
### Temporary Warning
> Some of the claims above are aspirational. `re-frame-trace` remains a WIP experiment. But [we're getting there](https://github.com/Day8/re-frame-trace/issues/118).
> Some of the claims above are aspirational. `re-frame-trace` [remains a WIP](https://github.com/Day8/re-frame-trace/issues/118).
## The Name
We debated internally about the name `re-frame-trace`. We knew that `-trace` was okay, but anemic because it talked about low level function, not higher level benefit. I wanted to call it `vox-datum` (voice of the data) but that was cruelly rejected, for reasons I don't care to remember. The pain. I mean, who the hell doesn't like a Latin name?? Philistines. Anyway, "insight" and "illumination" are the benefits, but they made the name too long. Naming things - its a nightmare! As is inertia. So, `-trace` it remains.
We debated internally about the name `re-frame-trace`. We knew that `-trace` was okay, but anemic because it talked about low level function, not higher level benefit. I wanted to call it `vox-datum` (voice of the data) but that was cruelly rejected, for reasons I don't care to remember. The pain. I mean, who the hell doesn't like a Latin name?? Philistines. Anyway, "insight" and "illumination" are the benefits, but they made the name too long. Naming things - it's a nightmare! As is inertia. So, `-trace` it remains.
## A Visual Sampler