Skip to content

Commit

Permalink
docs(README): refactor note on maintenance
Browse files Browse the repository at this point in the history
  • Loading branch information
freshgum-bubbles authored Nov 23, 2023
1 parent f11af26 commit 148945a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ Released under [MIT](./LICENSE) by [@freshgum](https://github.com/freshgum-bubbl
[^5]: In the future, I'll most likely look at renaming this package. That'll come naturally as part of a wider project. You'll probably notice that I avoid explicitly using this package's name in a lot of places; that will make it easier to update. The naming scheme is... unfortunate, and in retrospect I should have named it differently to avoid confusion with the original project.
[^6]: One example of such a project is [ListenBrainz Discord RPC](https://github.com/freshgum-bubbles/listenbrainz-discord-rpc), which makes use of this package to structure its functionality into modular services. There are some other examples on GitHub's *Dependents* view, too.
[^7]: An example of "magic", in this context, would be integration with the filesystem to read a configuration file in a proprietary format, and then using that to configure services -- while that might make more sense for Java developers, such features don't (in my experience) scale well in JavaScript. Also, we'd have to write a ton of editor integrations! `</ramble>`
[^8]: If the library is ever feature-complete, it'll still be maintained -- compatibility with the latest engines will still be tested. However, as stated prior, features would not be added for the sake of adding features. Therefore, if this package ever *becomes* feature-complete, **please don't ask me if it's abandoned!** If there haven't been any commits for over a year, it probably is; in that case, please fork it and continue my efforts. All power to you!
[^8]: If the library is ever feature-complete, it'll still be maintained -- compatibility with the latest engines will still be tested. However, as stated prior, features would not be added for the sake of adding features. Therefore, if this package ever *becomes* feature-complete (and is placed into maintenance mode), **there's no need to ask if it's abandoned.** If there haven't been any commits for over a year, it probably is; in that case, please fork it and continue my efforts. All power to you!

0 comments on commit 148945a

Please sign in to comment.