Add documentation to README #31
Conversation
|
Thanks @niccokunzmann - I'll read through this and your feature pull request within the next few days or so. As you've discovered, I tend to turn GitHub Actions off for many of my repositories. I'll run tests/linting locally during code review and may also turn GitHub Actions on again soon. |
|
Thanks! In the future, I also want to create transfers. |
| After installation, you should be able to import the package. | ||
|
|
||
| ```python | ||
| import pywisetransfer | ||
| ``` |
There was a problem hiding this comment.
Let's omit this; the package is a simple one, and provided that the installation process succeeds, this should too.
We should consider including it in complete code examples, however also avoid too much repetition.
| ```python | ||
| client = pywisetransfer.Client(api_key="your-api-key-here", environment="live") | ||
| ``` | ||
|
|
||
| - Create a `Client` object with your API key for the `sandbox` environment: | ||
|
|
||
| ```python | ||
| client = pywisetransfer.Client(api_key="your-api-key-here") | ||
| ``` |
There was a problem hiding this comment.
Generally I think we should make this readme friendly to newcomers, but I also want to balance that against how safe and mature the code is (I'll be more comfortable if we can reduce the number of external dependencies, for example).
Even when we're very confident about the safety and quality of the code, we should still write the documentation in a way that requires people to be very careful to enable production usage. So: at the very least we should present the sandbox environment first -- and perhaps we should remove the live example entirely.
| name: Law and Daughters 6423 | ||
| ``` | ||
|
|
||
| ### Receive Money |
There was a problem hiding this comment.
| ### Receive Money | |
| ### Account Details |
2 participants
Hi,
I am about to use your lib and I would like to improve the documentation of it.
This is a little taster to get to know each other. I do not want to invest a lot of time if you do not like the changes.
I would open an issue with changes I would like to make if you accept changes.
What do you think?
Greetings,
Nicco