Skip to content

Commit

Permalink
paper and outlook in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
benmaier committed May 24, 2019
1 parent 064a0bb commit c442b3f
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ The package is build around the philosophy that network manipulation and preproc

![example](https://github.com/benmaier/netwulf/raw/master/img/simple_example.gif)

## Paper

[![status](http://joss.theoj.org/papers/3a22c963a45dbddc8501a4b5ef4b2bf6/status.svg)](http://joss.theoj.org/papers/3a22c963a45dbddc8501a4b5ef4b2bf6)

If you use `netwulf` for your scientific work, consider citing us! We're currently [under review in JOSS](https://github.com/openjournals/joss-reviews/issues/1425).

## Install

Expand Down Expand Up @@ -61,7 +66,7 @@ This project is licensed under the [MIT License](https://github.com/benmaier/net

## Contributing

If you want to contribute to this project, please make sure to read the [code of conduct](https://github.com/benmaier/netwulf/blob/master/CODE_OF_CONDUCT.md) and the [contributing guidelines](https://github.com/benmaier/netwulf/blob/master/CONTRIBUTING.md).
If you want to contribute to this project, please make sure to read the [code of conduct](https://github.com/benmaier/netwulf/blob/master/CODE_OF_CONDUCT.md) and the [contributing guidelines](https://github.com/benmaier/netwulf/blob/master/CONTRIBUTING.md). We're always collecting ideas of what we want to implement next in the [outlook notes](ttps://github.com/benmaier/netwulf/blob/master/OUTLOOK.md).

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](code-of-conduct.md)

Expand Down
14 changes: 14 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ without code.

|example|

Paper
-----

|status|

If you use ``netwulf`` for your scientific work, consider citing us!
We're currently `under review in
JOSS <https://github.com/openjournals/joss-reviews/issues/1425>`__.

Install
-------

Expand Down Expand Up @@ -88,6 +97,9 @@ If you want to contribute to this project, please make sure to read the
conduct <https://github.com/benmaier/netwulf/blob/master/CODE_OF_CONDUCT.md>`__
and the `contributing
guidelines <https://github.com/benmaier/netwulf/blob/master/CONTRIBUTING.md>`__.
We're always collecting ideas of what we want to implement next in the
`outlook
notes <ttps://github.com/benmaier/netwulf/blob/master/OUTLOOK.md>`__.

|Contributor Covenant|

Expand Down Expand Up @@ -139,6 +151,8 @@ until the warnings disappear. Then do
.. |logo| image:: https://github.com/benmaier/netwulf/raw/master/img/logo_small.png
.. |example| image:: https://github.com/benmaier/netwulf/raw/master/img/simple_example.gif
.. |status| image:: http://joss.theoj.org/papers/3a22c963a45dbddc8501a4b5ef4b2bf6/status.svg
:target: http://joss.theoj.org/papers/3a22c963a45dbddc8501a4b5ef4b2bf6
.. |Documentation Status| image:: https://readthedocs.org/projects/netwulf/badge/?version=latest
:target: https://netwulf.readthedocs.io/en/latest/?badge=latest
.. |visualization example0| image:: https://github.com/benmaier/netwulf/raw/master/img/BA_1.png
Expand Down

0 comments on commit c442b3f

Please sign in to comment.