From 675c7f66383b3764da8faa71d1fb65350a7cb9fe Mon Sep 17 00:00:00 2001
From: Kevin Jahns <kevin.jahns@rwth-aachen.de>
Date: Thu, 13 Oct 2016 15:53:41 +0200
Subject: [PATCH] rephrase intro
---
README.md | 22 +++++++++++-----------
dist | 2 +-
2 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 88ad9f5a..72bd4a0a 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
# 
-Yjs is a framework for p2p shared editing on structured data like (rich-)text, json, and XML.
-It is similar to [ShareJs] and [OpenCoweb], but easy to use.
+Yjs is a framework for offline-first p2p shared editing on structured data like text, richtext, json, or XML.
+It is fairly easy to get started, as Yjs hides most of the complexity of concurrent editing.
For additional information, demos, and tutorials visit [y-js.org](http://y-js.org/).
### Extensions
@@ -42,7 +42,7 @@ Connectors, Databases, and Types are available as modules that extend Yjs. Here
|[richtext](https://github.com/y-js/y-richtext) | Collaborate on rich text. Supports two way binding to the [Quill Rich Text Editor](http://quilljs.com/)|
## Use it!
-Install Yjs, and its modules with [bower](http://bower.io/), or [npm](https://www.npmjs.org/package/yjs).
+Install Yjs, and its modules with [bower](http://bower.io/), or [npm](https://www.npmjs.org/package/yjs).
### Bower
```
@@ -91,17 +91,17 @@ bower i yjs y-memory y-webrtc y-array y-text
```
Here is a simple example of a shared textarea
-```
+```HTML
<!DOCTYPE html>
<html>
<body>
<script src="./bower_components/yjs/y.js"></script>
+ <!-- Yjs automatically includes all missing dependencies (browser only) -->
<script>
Y({
db: {
name: 'memory' // use memory database adapter.
- // name: 'indexeddb'
- // name: 'leveldb'
+ // name: 'indexeddb' // use indexeddb database adapter instead for offline apps
},
connector: {
name: 'webrtc', // use webrtc connector
@@ -117,9 +117,9 @@ Here is a simple example of a shared textarea
// The Yjs instance `y` is available
// y.share.* contains the shared types
- // Bind the textarea to y.share.textarea
+ // Bind `y.share.textarea` to `<textarea/>`
y.share.textarea.bind(document.querySelector('textarea'))
- }
+ })
</script>
<textarea></textarea>
</body>
@@ -134,6 +134,9 @@ Report _any_ issues to the [Github issue page](https://github.com/y-js/yjs/issue
# API
### Y(options)
+* Y.extend(module1, module2, ..)
+ * Add extensions to Y
+ * `Y.extend(require('y-webrtc'))` has the same semantics as `require('y-webrtc')(Y)`
* options.db
* Will be forwarded to the database adapter. Specify the database adaper on `options.db.name`.
* Have a look at the used database adapter repository to see all available options.
@@ -259,6 +262,3 @@ Yjs is licensed under the [MIT License](./LICENSE).
<yjs@dbis.rwth-aachen.de>
-[ShareJs]: https://github.com/share/ShareJS
-[OpenCoweb]: https://github.com/opencoweb/coweb/wiki
-
diff --git a/dist b/dist
index 549ab76b..b8dd7d18 160000
--- a/dist
+++ b/dist
@@ -1 +1 @@
-Subproject commit 549ab76b4215dab2299dbcbde271c810aae2ab51
+Subproject commit b8dd7d186291b7137cbb96d4f0b398874a8c0718
--
GitLab