aldrin-labs / ramm-evm-sdk

RAMM SDK for EVM chains
2 stars 42 forks source link

We need nice readme asap #1

Open 0xrinegade opened 7 months ago

0xrinegade commented 7 months ago

it must explain how to use sdk with some code samples to simplify DX of devs thank you

ankitzm commented 7 months ago

Hey @0xrinegade, would love to know what work does the code do and how to set up this repo. btw, is this an node package ?

0xrinegade commented 7 months ago

hey i didnt deploy to npm yet, will do today they code is simple a wrapper for onchain RAMM deployment, which is basically an AMM

0xrinegade commented 7 months ago

@ankitzm

ankitzm commented 7 months ago

got it, am trying to run it now. Will update you if it I face any problem. Can you please assign this issue to me.

0xrinegade commented 7 months ago

@ankitzm gl fren, patiently waiting <3

ankitzm commented 7 months ago

Couldn't understand much of how to use it in the code, so wan't able to explain it in a file. Is there some sample code on how it should be used, so it would be easy to put that in readme.

0xrinegade commented 7 months ago

@ankitzm you can take a look at tests folder, it's an example of how to use basically

ankitzm commented 7 months ago

Tried understanding but wasn't able to do it. Let some other people you understand it well do it.

Folawewo commented 7 months ago

i'm working on this for you @0xrinegade

Folawewo commented 7 months ago

hey @0xrinegade, how are you?

i created the RAMM SDK Documentation with detailed explanation on how to use the sdk with some code samples. https://github.com/aldrin-labs/ramm-evm-sdk/pull/18

i like what you are building, it's a useful technology, let me know if i could always also contribute to it, thank you.