Skip to content

Commit 50ab795

Browse files
committed
Fix version bump on shield. Tweak copy and order of README
1 parent 0fb85d1 commit 50ab795

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![code2flow logo](https://raw.githubusercontent.com/scottrogowski/code2flow/master/assets/code2flowlogo.png)
22

3-
![Version 2.3.1](https://img.shields.io/badge/version-2.3.0-brightgreen) ![Build passing](https://img.shields.io/badge/build-passing-brightgreen) ![Coverage 100%](https://img.shields.io/badge/coverage-100%25-brightgreen) ![License MIT](https://img.shields.io/badge/license-MIT-green])
3+
![Version 2.3.1](https://img.shields.io/badge/version-2.3.1-brightgreen) ![Build passing](https://img.shields.io/badge/build-passing-brightgreen) ![Coverage 100%](https://img.shields.io/badge/coverage-100%25-brightgreen) ![License MIT](https://img.shields.io/badge/license-MIT-green])
44

55
Code2flow generates [call graphs](https://en.wikipedia.org/wiki/Call_graph) for dynamic programming language. Code2flow supports Python, Javascript, Ruby, and PHP.
66

@@ -18,9 +18,9 @@ Code2flow is useful for:
1818

1919
Code2flow will provide a *pretty good estimate* of your project's structure. No algorithm can generate a perfect call graph for a [dynamic language](https://en.wikipedia.org/wiki/Dynamic_programming_language) - even less so if that language is [duck-typed](https://en.wikipedia.org/wiki/Duck_typing). See the known limitations in the section below.
2020

21-
*(Below: Code2flow running on itself (excl javascript, PHP, & Ruby for clarity))*
21+
*(Below: Code2flow running against a subset of itself)*
2222

23-
![code2flow running against itself](https://raw.githubusercontent.com/scottrogowski/code2flow/master/assets/code2flow_output.png)
23+
![code2flow running against a subset of itself](https://raw.githubusercontent.com/scottrogowski/code2flow/master/assets/code2flow_output.png)
2424

2525
Installation
2626
------------
@@ -125,6 +125,15 @@ How to contribute
125125
3. **Add a language**: While dense, each language implementation is between 250-400 lines of code including comments. If you want to implement another language, the existing implementations can be your guide.
126126

127127

128+
Unit tests
129+
------------------
130+
131+
Test coverage is 100%. To run:
132+
133+
pip install -r requirements_dev.txt
134+
make test
135+
136+
128137
License
129138
-----------------------------
130139

@@ -148,15 +157,6 @@ Unrelated projects
148157
The name, "code2flow", has been used for several unrelated projects. Specifically, the domain, code2flow.com, has no association with this project. I've never heard anything from them and it doesn't appear like they use anything from here.
149158

150159

151-
Unit tests
152-
------------------
153-
154-
Test coverage is 100%. To run:
155-
156-
pip install -r requirements_dev.txt
157-
make test
158-
159-
160160
Feedback / Contact
161161
-----------------------------
162162

0 commit comments

Comments
 (0)