Bring documentation in line with Ruby/Node/Python/Java libraries

interfax / interfax-php

Fax send and receive in PHP with the InterFAX REST API

https://www.interfax.net/en/dev/php

MIT License

13 stars 4 forks source link

Bring documentation in line with Ruby/Node/Python/Java libraries #2

Closed cbetta closed 8 years ago

cbetta commented 8 years ago

@splatEric can we bring the README formatting in line with the other docs? Have a look at the Ruby/Node/Python/Java libraries and you see we mostly used the same syntax throughout. For maintenance purposes please can we stick as much as possible to this flow?

splatEric commented 8 years ago

The README structure is based on the ruby library README ... can you clarify what discrepancies you are concerned about?

cbetta commented 8 years ago

@splatEric it's kinda of but not completely. Please use the template laid out in the Ruby library to bring things in line.

For example, the PHP README:

and the Ruby README:

splatEric commented 8 years ago

Okay, I've gone through and brought it more into line with the ruby readme, although obviously there are some discrepancies as it is not implemented in exactly the same way.

cbetta commented 8 years ago

@splatEric perfect