Exfile - how to document?

keichan34 / exfile

File upload persistence and processing for Phoenix / Plug

MIT License

90 stars 19 forks source link

Exfile - how to document? #29

Closed asiniy closed 8 years ago

asiniy commented 8 years ago

I found exfile very powerful library, but lack of documentation makes me stressful. I want to share details - i.e., how to test this library functionality, with ex_unit & ex_machina.

But I don't know where I can do it. Usual solutions:

Directly to README.md
Work with wiki
Create a docs directory, and puts recipes to it

I prefer the first one, but I'm not sure about correctness of my choice. What could you say?

keichan34 commented 8 years ago

API documentation is automatically generated with exdoc, and published to hexdocs (although, it isn't perfect). For instructions on how to test exfile, those should probably go in to README.md, or some other markdown file in the root directory if it doesn't belong there. If you want to help improve documentation, it would be great if you could send a PR with what you think makes sense and we can discuss from there :)

asiniy commented 8 years ago

@keichan34 got it