matthewmueller / next-cookies

Tiny little function for getting cookies on both client & server with next.js.
368 stars 17 forks source link

Improving documentation / README #10

Closed dbrrt closed 5 years ago

dbrrt commented 5 years ago

Is that project still maintained? If so it'd be great to improve the existing documentation.

nfriedly commented 5 years ago

It is being maintained, but not actively developed.

There's not a whole lot to this project, and I don't anticipate adding much to it.

However additional documentation is always welcome :)

dbrrt commented 5 years ago

I can provide some help on documentation for this library if it can be at the end, easier to integrate in nextjs framework.

skdigital commented 5 years ago

Anyone looking to update the docs? No offense and all but they are absolutely spartan. I would find it easier navigating a Chinese community shopping center than actually getting this cookie to work in my super simple next project. These docs hardly beginner friendly, I would put in a PR to change things up but I am a noob lol.

nfriedly commented 5 years ago

There you go. I added a compete working example, documentation for the library function, and documentation for the browser's built-in cookie setting API.

There are now more than 4x as many lines of documentation as of code :)