search

NethermindEth / juno

Starknet client implementation.
https://juno.nethermind.io
Apache License 2.0
372 stars 158 forks source link

No clear documentation and readme is not very helpful #1765

Closed fishonamos closed 1 month ago

fishonamos commented 3 months ago

I was trying to integrate Juno to Carbonable Indexer and use it as data source but I discovered that Juno has no documentation. The readme is not readable and does not address a lot of issues. I think Juno should have a comprehensive documentation or a detailed readme. I can help with that if the team can provide more details.

wojciechos commented 3 months ago

Hey! Can you share missing issues that should be covered? Also, you might find our docs here: https://juno.nethermind.io

fishonamos commented 3 months ago

The missing issue is that there should be a detailed step for integrating Juno with other services to use a data source. Although, it is pretty straightforward for some of us, I think is it something a lot of people will be interested in.

LordGhostX commented 1 month ago

@fishonamos 👋

Thank you for opening this issue. I agree that the current docs aren't very detailed, and beginners can get lost, so https://github.com/NethermindEth/juno/pull/1857 resolves things.

It also includes snippets to interact with a node using starknet.js, starknet.go, and starknet.rs aside cURL and the WebSocket server.

I'll be closing this issue. Feel free to open new ones to suggest more improvements in the future 🎉