Design & implement Datagram public API v1

mjp0 / datagram-node

📡 Datagram is an open-source data platform that you can use to build secured & shareable p2p databases with anyone.

https://datagramjs.com

Apache License 2.0

1 stars 0 forks source link

Design & implement Datagram public API v1 #19

Open mjp0 opened 5 years ago

mjp0 commented 5 years ago

Public API is something that can make or break any technical project. I have picked few guiding principles for the design:

Intuitive and "familiar" to use
Ask as little as possible
Do as much as possible

I hope that the above will create an API that doesn't require reading an O'Reilly book to be usable.

Deliverables

[ ] Documented API design with arguments and explanations
[x] Implementation of the designed API

mjp0 commented 5 years ago

I've completed the basic outline of the API. It still lacks documented arguments and explanations. I'm going to keep this active but freeze it until I have completed the first implementation. Implementation can many times bring out technical or workflow issues you don't see while designing.