tablelandnetwork / go-tableland

Go implementation of the Tableland database/validator - run your own node, handling on-chain events and serving read-queries
https://tableland.xyz/
MIT License
53 stars 10 forks source link

docs: update README #586

Closed dtbuchholz closed 1 year ago

dtbuchholz commented 1 year ago

Summary

Updated README with the latest setup steps. Closes https://github.com/tablelandnetwork/go-tableland/issues/539.

Context

The README was outdated and inaccurate, and we had internal docs already describing the newer steps required.

Implementation overview

N/A

Implementation details and review orientation

N/A

Checklist

dtbuchholz commented 1 year ago

I referenced everything from the Notion doc with some tweaks here and there, so lmk if there's anything missing or misinterpreted!

(Note that I originally wanted to keep this README "light" and point to the docs site for much of this, but I wasn't sure how to abstract away the implementation details since all of those setup steps seemed useful.)

dtbuchholz commented 1 year ago

@avichalp adjusted the README with your feedback—lmk how it looks, and then i can also duplicate this on our docs site if it's 👍