浏览代码

More visual README for users

* Add screenshot for embedded view mode
* Add Pàdé
Nÿco 5 年之前
父节点
当前提交
0082c0ce60
共有 1 个文件被更改,包括 20 次插入12 次删除
  1. 20 12
      README.md

+ 20 - 12
README.md

@@ -22,20 +22,32 @@ A demo showing anonymous login is available at [https://conversejs.org/demo/anon
 and a demo which shows how you can embed a single chat room into a page is
 avialable at [https://conversejs.org/demo/embedded.html](https://conversejs.org/demo/embedded.html).
 
-### Converse in overlay mode
+## Documentation
+
+The developer/integrator documentation can be found at [https://conversejs.org/docs/html](https://conversejs.org/docs/html).
+
+You'll probably want to begin with the [quickstart guide](https://conversejs.org/docs/html/quickstart.html),
+which shows you how to use the CDN (content delivery network) to quickly get a demo up and running.
+
+## Converse modes
+
+### Overlay
 
-![Screenshot of Converse](https://opkode.com/img/Screen-Shot-2018-09-19-at-19.15.16.png)
+In overlay mode, Converse appears overlayed chats on top of the website.
 
-## Converse in fullpage mode
+![Screenshot of Converse in overlay mode](https://opkode.com/img/Screen-Shot-2018-09-19-at-19.15.16.png)
+
+### Fullpage
+
+In fullpage mode, Converse behaves like a single-page app that covers the whole browser viewport.
 
 ![Screenshot of Converse in fullpage mode](https://opkode.com/img/Screen-Shot-2018-09-19-at-19.16.46.png)
 
-## Documentation
+### Embedded
 
-The developer/integrator documentation can be found at [https://conversejs.org/docs/html](https://conversejs.org/docs/html).
+In embedded mode, Converse can be embedded into an element in the DOM.
 
-You'll probably want to begin with the [quickstart guide](https://conversejs.org/docs/html/quickstart.html),
-which shows you how to use the CDN (content delivery network) to quickly get a demo up and running.
+![Screenshot of Converse in embedded mode](https://opkode.com/img/Converse-embedded.png)
 
 ## Features
 -   Available as overlayed chat boxes or as a fullscreen application. See [inverse.chat](https://inverse.chat) for the fullscreen version.
@@ -74,16 +86,12 @@ which shows you how to use the CDN (content delivery network) to quickly get a d
 -   **[Patternslib](http://patternslib.com)**: [patterns.converse](https://github.com/jcbrand/patterns.converse)
 -   **[Roundcube](https://roundcube.net)**: [roundcube-converse.js-xmpp-plugin](https://github.com/devurandom/roundcube-converse.js-xmpp-plugin)
 -   **[Wordpress](https://wordpress.org)**: [ConverseJS](https://wordpress.org/plugins/conversejs/)
+-   **[Pàdé](https://www.igniterealtime.org/projects/pade/index.jsp)**: [Pàdé](https://www.igniterealtime.org/projects/pade/index.jsp)
 -   **[Plone](https://plone.com)**: [collective.converse](https://github.com/collective/collective.converse)
 -   **[Alfresco](https://www.alfresco.com)**: [alfresco-js-chat-share](https://github.com/keensoft/alfresco-js-chat-share)
 -   **[Friendica](https://friendi.ca)**: [converse](https://github.com/friendica/friendica-addons/tree/master/xmpp/converse)
 -   **[Tiki Wiki CMS Groupware](https://tiki.org)**: [built-in optional feature](https://doc.tiki.org/XMPP)
 
-## Stand-alone applications
-
--   **[ConverseJS for Ubuntu-Touch](https://open-store.io/app/conversejs.povoq)**: [source code](https://github.com/poVoq/conversejs-ubports)
--   **[Chimeverse for Mac OS X](https://github.com/nick-denry/Chimeverse)**: Electron based app
-
 ## Tests
 
 We use behavior-driven tests written with [jasmine.js](https://jasmine.github.io/).