summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSiddhant Goel <me@sgoel.dev>2021-01-19 08:20:55 +0100
committerSiddhant Goel <me@sgoel.dev>2021-01-19 08:20:55 +0100
commitd73cfc1a615e1fc69715aa5cb3aa491d446469f1 (patch)
treefcb02a4d01eef4e21c1af503c0be8635d99e4d7d
parent22e2a4052bb0571dca088080038051c6d72cdebb (diff)
docs: update usage section in README
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0f17273..e5f8495 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,14 @@ from.
## Usage
+If you're not familiar with how to import external data into Beancount, please
+read [this guide] first.
+
+Adjust your [config file] to include `ECImporter` and `CreditImporter`
+(depending on what account you're trying to import).
+
+A sample configuration might look like the following:
+
```python
from beancount_ing_diba import ECImporter
@@ -40,5 +48,25 @@ CONFIG = [
]
```
-[ING-DiBa]: https://www.ing-diba.de/
+Once this is in place, you should be able to run `bean-extract` on the command
+line to extract the transactions and pipe all of them into your Beancount file.
+
+```sh
+$ bean-extract /path/to/config.py transaction.csv >> you.beancount
+```
+
+## Contributing
+
+Contributions are most welcome!
+
+Please make sure you have Python 3.6+ and [Poetry] installed.
+
+1. Clone the repository: `git clone https://github.com/siddhantgoel/beancount-ing-diba`
+2. Install the packages required for development: `poetry install`
+3. That's basically it. You should now be able to run the test suite: `poetry run py.test`.
+
[Beancount]: http://furius.ca/beancount/
+[config file]: https://beancount.github.io/docs/importing_external_data.html#configuration
+[ING-DiBa]: https://www.ing-diba.de/
+[Poetry]: https://python-poetry.org/
+[this guide]: https://beancount.github.io/docs/importing_external_data.html