TudbuT/conduit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README.md

Browse source 
Signed-off-by: strawberry <strawberry@puppygock.gay>
This commit is contained in:
strawberry 2024-03-15 21:34:44 -04:00 • committed by June
parent 99efa6d622
commit 1c67a1da45
1 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -6,7 +6,7 @@
#### What is Matrix? #### What is Matrix?
[Matrix](https://matrix.org) is an open network for secure and decentralized [Matrix](https://matrix.org) is an open network for secure and decentralized
communication. Users from every Matrix homeserver can chat with users from all communication. Users from every Matrix homeserver can chat with users from all
other Matrix servers. You can even use bridges (also called Matrix appservices) other Matrix servers. You can even use bridges (also called Matrix Appservices)
to communicate with users outside of Matrix, like a community on Discord. to communicate with users outside of Matrix, like a community on Discord.
#### What is the goal? #### What is the goal?
@ -23,9 +23,7 @@ An official conduwuit server ran by me is available at transfem.dev ([element.tr
conduwuit is a fork of Conduit which is in beta, meaning you can join and participate in most conduwuit is a fork of Conduit which is in beta, meaning you can join and participate in most
Matrix rooms, but not all features are supported and you might run into bugs Matrix rooms, but not all features are supported and you might run into bugs
from time to time. conduwuit attempts to fix and improve the majority of upstream Conduit bugs from time to time.
or UX issues that are taking too long to be resolved, or unnecessary Matrix or developer
politics halting simple things from being merged or fixed, and general inactivity.
There are still a few nice to have features missing that some users may notice: There are still a few nice to have features missing that some users may notice:
@ -37,18 +35,16 @@ See [DIFFERENCES.md](DIFFERENCES.md)
#### Why does this fork exist? Why don't you contribute back upstream? #### Why does this fork exist? Why don't you contribute back upstream?
I have tried, but: I now intend on contributing back as time and mental energy sees fit, but my fork still exists as a way to:
- unnecessary Matrix / developer politics - avoid unnecessary Matrix and general developer politics
- bikeshedding unnecessary or irrelevant things in MRs - avoid bikeshedding unnecessary or irrelevant things in upstream MRs
- disagreement with how the upstream project is maintained including the codebase - Fast tracked bug fixes, performance improvements, security improvements, and new features
- upstream maintainer inactivity - Have early access to MRs that may not be suitable/acceptable for Conduit (e.g. too niche, too advanced for general users, only being blocked due to pending on contributor actions that we can fix ourselves downstream, pending Matrix spec stuff, etc)
- questionable community members - Support unspecced or WIP features
- lack of MR reviews or issue triaging and no upstream maintainer interest in receiving help - Have official support for other OS's like Windows, macOS, and BSD.
- severe bugs, including denial of service and other likely vulnerabilities, not being merged due to things mentioned above - Have a **stable** testing ground for some MRs or new features and bug fixes
- no interest in adding co-maintainers to help out
are what are keeping me from contributing. If the state of the upstream project improves, I'm And various other reasons that may not be listed here.
willing to start contributing again. As is, I think if folks want a more polished and well-kept version of Conduit, conduwuit exists for that.
#### How can I deploy my own? #### How can I deploy my own?
@ -66,7 +62,7 @@ If you want to connect an Appservice to Conduit, take a look at [APPSERVICES.md]
2. Ask someone to assign the issue to you (comment on the issue or chat in 2. Ask someone to assign the issue to you (comment on the issue or chat in
[#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay)) [#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay))
3. Fork the repo and work on the issue. 3. Fork the repo and work on the issue.
4. Submit a PR (please keep contributions to the GitHub repo, main development is done here, not the GitLab repo which exists just as a mirror.) 4. Submit a PR (please keep contributions to the GitHub repo, main development is done here, not the GitLab repo which exists just as a mirror. If you are avoiding GitHub, feel free to join our Matrix chat to get your patch in.)
#### Contact #### Contact
@ -84,6 +80,10 @@ GitHub Sponsors: <https://github.com/sponsors/girlbossceo>
No official conduwuit logo exists. Repo and Matrix room picture is from bran (<3). No official conduwuit logo exists. Repo and Matrix room picture is from bran (<3).
#### Is it conduwuit or Conduwuit?
Both.
#### Mirrors of conduwuit #### Mirrors of conduwuit
GitHub: <https://github.com/girlbossceo/conduwuit>\ GitHub: <https://github.com/girlbossceo/conduwuit>\