freeconf / restconf

Implementation of RESTCONF Management protocol - IETF RFC8040
Apache License 2.0
29 stars 9 forks source link

Feature request: Improve README #39

Open rFronteddu opened 1 year ago

rFronteddu commented 1 year ago

Hi, I was trying to figure out how to add a list to my restconf interface and I eventually found your more comprehensive car example. I think adding a couple of examples for lists and maps in the README would improve adoption. I would also clarify that reflection doesn't work in that case and highlight the parts where it does. I would also show how to update and query list/maps using curl. I would provide you with my example but you already have a better one in your car.yaml.

Let me know if you would like me to contribute with an example.

dhubler commented 1 year ago

honestly, i think I should remove all tech docs from the README and advertise the official docs better

https://freeconf.org/docs/examples/node-reflect/

It's in the first sentence of the README but honestly I think the eyes gravitates to the code and miss it.

Docs are better but could use improvement.

I was just working on the car code because I ported it to python for example of how to FreeCONF in python and thought I should turn this into "Getting Started Part II" or something like that.

On Sat, Jul 22, 2023 at 2:26 PM Roberto Fronteddu @.***> wrote:

Hi, I was trying to figure out how to add a list to my restconf interface and I eventually found your more comprehensive car example. I think adding a couple of examples for lists and maps in the README would improve adoption. I would also clarify that reflection doesn't work in that case and highlight the parts where it does. I would also show how to update and query list/maps using curl. I would provide you with my example but you already have a better one in your car.yaml.

Let me know if you would like me to contribute with an example.

— Reply to this email directly, view it on GitHub https://github.com/freeconf/restconf/issues/39, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAACA7RX2CVT7EUQIQE7LMLXRQLL3ANCNFSM6AAAAAA2T7OZH4 . You are receiving this because you are subscribed to this thread.Message ID: @.***>