diff options
author | sualko <klaus@jsxc.org> | 2019-07-24 12:30:06 +0300 |
---|---|---|
committer | sualko <klaus@jsxc.org> | 2019-07-24 12:30:06 +0300 |
commit | ca5ca6e0e9b2050b4df2e188195fbe63e4899efc (patch) | |
tree | d57db7759d2188d92df7a5c827f60c747fdf41ff /README.md | |
parent | 706875935cee3cd0b8a1e740de83463332e0ff91 (diff) |
chore: update readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 33 |
1 files changed, 28 insertions, 5 deletions
@@ -1,20 +1,43 @@ # JavaScript XMPP Client [![Build Status](https://travis-ci.org/jsxc/jsxc.svg?branch=master)](https://travis-ci.org/jsxc/jsxc) -[![Dependency Status](https://dependencyci.com/github/jsxc/jsxc/badge)](https://dependencyci.com/github/jsxc/jsxc) [![Code Quality: Javascript](https://img.shields.io/lgtm/grade/javascript/g/jsxc/jsxc.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jsxc/jsxc/context:javascript) [![Total Alerts](https://img.shields.io/lgtm/alerts/g/jsxc/jsxc.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/jsxc/jsxc/alerts) Real-time chat app. This app requires an external XMPP server (openfire, ejabberd etc.). +## :heart_eyes: Features +JSXC provides the following features: + +- Federated real-time communication with XMPP +- One-to-one conversation +- Multi-user conversation +- File transfer +- Video calls +- Internationalisation +- Desktop notifications +- End-to-end encrypted two-party communication +- Responsive layout +- Emoticons :two_hearts: +- Multi-Tab +- Screen sharing + You find a full list of features, supported protocols and browsers on [our homepage](http://www.jsxc.org). -If you are looking for install instructions or developer notes, please also checkout our [wiki](https://github.com/jsxc/jsxc/wiki/). +## :camera: Screenshots + +![](https://www.jsxc.org/images/v3.0.0/screenshot-example.png) +![](https://www.jsxc.org/assets/screenshot-nextcloud-latest.png) -## Contribution +## :rocket: Installation +If you are looking for install instructions or developer notes, please check out our [official documentation](https://jsxc.readthedocs.io/en/latest/index.html). -Contribution is greatly appreciated. A few hints are in our [Contributor Guide](https://github.com/jsxc/jsxc/wiki/Contributor-Guide). +## :clap: Contribution +Contribution is greatly appreciated. Following a couple of ideas, how you can contribute: -To contribute new or fixed **translations in the localized messages**, please use [WebTranslateIt](https://github.com/jsxc/jsxc/wiki/Contributor-Guide#translate-jsxc-into-your-language). +- [Report a bug](https://jsxc.readthedocs.io/en/latest/contributor-guide.html#report-a-bug) +- [Contribute code](https://jsxc.readthedocs.io/en/latest/contributor-guide.html#contribute-code) +- [Translate JSXC into your language](https://jsxc.readthedocs.io/en/latest/contributor-guide.html#translate-jsxc-into-your-language) +- [Announce](https://jsxc.readthedocs.io/en/latest/contributor-guide.html#announce) Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. |