Improved and updated README & CHANGELOG

indiachan-spamvector
Thomas Lynch 1 year ago
parent 9dee0954b5
commit 877e30d395
Signed by: fatchan
GPG Key ID: A7E5E8B7E11EE92D
  1. 29
      CHANGELOG.md
  2. 31
      README.md

@ -1,25 +1,34 @@
### 1.0.0
Version 1.0.0 is here. jschan is mature enough and there's no need to go to version 0.999, but this does not mean it is perfect or complete!
I want to keep improving jschan and there are plenty of new features and changes planned for versions 2, 3, and beyond.
Version 1.0.0 is here. jschan is stable and mature enough and has been for a while. There's no need to go to version 0.9999.9999 and I am comfortable enough to call it "Version 1".
Of course, that doesn't mean jschan is perfect or finished by any means. I want to keep improving jschan and there are plenty of new features and changes planned for versions 2, 3, and beyond.
Thank you so much to all the jschan site admins, users & contributors for your help along the way. Your contributions have been invaluable to making this software great.
Special shoutout to l29utp0 & loynet (ptchan.org), Homicide (94chan.org) and some_random_guy (trashchan.xyz).
-Tom
Now, back to the program. Here are the changes for 1.0.0, with one especially notable feature:
- Multiple language support. jschan now supports language packs. There is a global and board-level language setting which completely translates the interface to another language. No javascript required.
- An effort has been made to translate everything, but given there is almost 4 years of code, some things may have slipped through the cracks. If something isn't translated, please report it on gitgud.
- 1.0.0 includes three* language packs: English (en-GB) and Portuguese (pt-PT) (Russian machine translation is also included, but may not be accurate).
- Huge credit to the ptchan.org admins for providing the Portuguese translation.
- Contributions for new language packs or improvements to existing ones are very welcome! Reach out via email/IRC to discuss imbursement for contributing language packs.
- Note: "global" pages e.g. overboards will adhere to global language setting. In a future iteration, these will be updated to (optionally, with global setting) support adhering to users browser language header for better UX going between a non-global language board and global pages.
- Improve the css and markup to only show the appropriate wording e.g "tap" or "click" in tooltips depending if you are on mobile/desktop.
Now, back to the program. Here are the changes for 1.0.0
- **Multiple language support.**
jschan now supports language packs. There is a global and board-level language setting which completely translates the interface to another language. Using server side rendering and logic, so it remains noscript compatible.
An effort has been made to translate everything, but given there is almost 4 years of code, some things may have slipped through the cracks. If something isn't translated, please report it on gitgud.
1.0.0 includes three* complete language packs:
- English (en-GB)
- Portuguese (pt-PT)
- Russian* (ru-RU) *Machine translated, may not be accurate
Huge credit to the ptchan.org admins for providing the Portuguese translation.
Contributions for new language packs or improvements to existing ones are very welcome! **Reach out via email, IRC, or session (See README.md) to discuss imbursement for contributing language packs.**
Note: "global" pages e.g. overboards will adhere to global language setting. In a future iteration, these will be updated to (optionally, with global setting) support adhering to users browser language header for better UX going between a non-global language board and global pages.
- Notify the user when making a playlist from a thread if there were no files, rather than just silently logging.
- Improves the css and markup to only show the appropriate wording e.g "tap" or "click" in tooltips depending if you are on mobile/desktop.
- Improve the installation process to fix a potential issue with the database connection settings.
- Customflags will now show correctly when editing a post on a board with custom flags enabled.
- Security improvement to the 2FA validation flow during login.
- Log a few more errors related to hcaptcha/recaptcha, for debugging purposes. (already caught and returned in a friendly manner)
- Remove showing language and relevance data when auto detecting highlighted code block language
- Add more themes (cybhub, digi, favela, ptchan, teletext).
- More minor bugfixes to permissions pages displays.
### 0.11.4

@ -1,25 +1,28 @@
# jschan
Anonymous imageboard software.
Anonymous imageboard software that doesn't suck.
Live instance: https://94chan.org
Live instances (Unofficial):
- English: https://94chan.org
- Português: https://ptchan.org
API documentation: [fatchan/jschan-docs](https://gitgud.io/fatchan/jschan-docs/) - Gitgud pages link: https://fatchan.gitgud.site/jschan-docs/#introduction
Join the IRC: [open in client](ircs://irc.fatpeople.lol:6697/general) OR: [webchat](https://irc-web.fatpeople.lol/#general)
Contact via:
- IRC: [open in client](ircs://irc.fatpeople.lol:6697/general) or [webchat](https://irc-web.fatpeople.lol/#general)
- [Session](https://getsession.org/): `051b2ff270769d20764fa1b8e6bc3240b0a3c28ffb3242e7cce60db479b23ef427`
- Email: see my gitgud profile
## Features
- [x] Multiple language support (currently English & Portuguese)
- [x] User created boards ala [infinity](https://github.com/ctrlcctrlv/infinity)
- [x] Multiple language support (en-GB, pt-PT, ru-RU included)
- [x] Optional user created boards ala [infinity](https://github.com/ctrlcctrlv/infinity)
- [x] Multiple files per post
- [x] [Tegaki](https://github.com/desuwa/tegaki) applet with drawing and replays
- [x] Antispam/Anti-flood & DNSBL
- [x] 3 customisable inbuilt captchas + 2 third party captchas (hcaptcha & recaptcha)
- [x] [API documentation](https://fatchan.gitgud.site/jschan-docs/)
- [x] Built-in webring (compatible w/ [lynxchan](https://gitlab.com/alogware/LynxChanAddon-Webring) & [infinity](https://gitlab.com/Tenicu/infinityaddon-webring))
- [x] [Tegaki](https://github.com/desuwa/tegaki) applet with drawing and replays
- [x] Two factor authentication (TOTP) for accounts
- [x] Manage everything from the web panel
- [x] Detailed accounts permissions system
- [x] Granular account permissions
- [x] Works properly with anonymizer networks (Tor, Lokinet, etc)
- [x] Beautiful bundled frontend with lots of themes and options, see below:
@ -35,11 +38,15 @@ See [INSTALLATION.md](INSTALLATION.md) for instructions on setting up a jschan i
See [CHANGELOG.md](CHANGELOG.md) for changes between versions.
## Contributing
Interested in contributing to jschan development? See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
## Related Projects
Here are some other projects related to jschan that you might find useful. **These are not official or otherwise guaranteed to work or be safe and should be used at your own risk.**
- [fatchan/jschan-api-go](https://gitgud.io/fatchan/jschan-api-go) - WIP Golang API Client for jschan.
Official:
- [fatchan/jschan-docs](https://gitgud.io/fatchan/jschan-docs/) - API Documentation for jschan ([gitgud pages](https://fatchan.gitgud.site/jschan-docs/#introduction))
- [fatchan/jschan-api-go](https://gitgud.io/fatchan/jschan-api-go) - WIP Golang API Client for jschan ([gitgud pages](https://fatchan.gitgud.site/jschan-api-go/pkg/jschan/))
Unofficial: **Not guaranteed to work or be safe, use at your own risk.**
- [ussaohelcim/jschan-api-sdk](https://github.com/ussaohelcim/jschan-api-sdk) - JavaScript/TypeScript SDK for jschan.
- [ussaohelcim/jschan-api-types](https://github.com/ussaohelcim/jschan-api-types) - TypeScript typings for jschan API.
- [myumyu/globalafk](https://gitgud.io/myumyu/globalafk/) - "A simple python script that sends ugly notifications when something happens on a jschan imageboard that you moderate."

Loading…
Cancel
Save