Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/Examples on building a bridge #147

Open
dvcrn opened this issue Nov 26, 2023 · 3 comments
Open

Docs/Examples on building a bridge #147

dvcrn opened this issue Nov 26, 2023 · 3 comments

Comments

@dvcrn
Copy link

dvcrn commented Nov 26, 2023

Hi! I'm interested in building bridges on top of this library, but there's currently little documentation or examples of what needs to be implemented, or what the bridge lifecycle is, which makes getting started a bit hard.

Is there a very basic bridge that implements the bare-minimum that could be used as a base for starting? I'm currently reading through the code of the slack and gmessages bridges

@sumnerevans
Copy link
Member

Reading and copying an existing bridge is the documentation.

@dvcrn
Copy link
Author

dvcrn commented Dec 7, 2023

That doesn't mean that this can't be improved to make it easier to get into bridge development, even if it's just a lifecycle / state diagram, explanation in the README, or examples in the godoc. Easier to get started can motivate more people (like myself) to get into bridge development during a bit of free time, and expand the matrix ecosystem

The current bridges can get quite complex, and not all of this is needed to bootstrap a simple relay bridge 😅

@jkandasa
Copy link

I see the following doc and blogs looks interesting

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants