Skip to content

Commit

Permalink
Add notebook manual to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MartineDeVos authored Nov 23, 2021
1 parent cef76f9 commit 766d962
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@ In your terminal type:

`$ pip install anonymoUUs`

## Getting started
Get started with the anonymoUUs package by trying it out in this [notebook](/anonymouus/examples/try_testing.ipynb) manual


Prerequisites:
* download the testdata from the [test_data folder](/anonymouus/tests/test_data)
* make sure you have [jupyter notebook](https://jupyter.org/install) installed


## Usage

In order to replace words or patterns you need a replacement-mapping in the form of:
Expand Down Expand Up @@ -161,4 +170,4 @@ def _read_file(self, source: Path):

Cleaning up this document

Testing! Sweet momma, it needs testing.
Testing! Sweet momma, it needs testing.

0 comments on commit 766d962

Please sign in to comment.