Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct markdown headings #63

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions README
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
arbor.js
--------
# arbor.js


Arbor is a graph visualization library built with web workers and
jQuery. Rather than trying to be an all-encompassing framework, arbor
Expand All @@ -15,8 +15,7 @@ that make your project unique – the graph data and your visual style
– rather than spending time on the physics math that makes the
layouts possible.

Installation
------------
## Installation

To use the particle system, add jquery and the file at lib/arbor.js
to your path somewhere and include them in your html:
Expand All @@ -34,8 +33,7 @@ decide if this appeals to you or not).
<script src="path/to/arbor-tween.js"></script>


Getting Started
---------------
## Getting Started

The docs folder contains a sample project that demonstrates some of the
basic idioms for working with the library to build a visualization. More
Expand All @@ -46,8 +44,7 @@ at arborjs.org. But since all of them use xhr to fetch their data, you'll
still need to view them from an http server. If you don't have a copy of
apache handy, use the demo-server.sh script to create a local server.

Colophon
--------
## Colophon

Arbor’s design is heavily influenced by Jeffrey Bernstein’s excellent
Traer Physics[1] library for Processing. In addition, much of the
Expand All @@ -62,14 +59,12 @@ code.
[2] <https://github.com/dhotson/springy>
[3] <http://arborjs.org/docs/barnes-hut>

Contribute
----------
## Contribute

Code submissions are greatly appreciated and highly encouraged. Please send
pull requests with fixes/enhancements/etc. to samizdatco on github. The
oldschool may also pipe their diff -u output to [email protected].

License
-------
## License

Arbor is released under the MIT license. http://en.wikipedia.org/wiki/MIT_License
Arbor is released under the MIT license. http://en.wikipedia.org/wiki/MIT_License