Skip to content

Commit bb7349a

Browse files
Improve documentation on developing
1 parent bcee916 commit bb7349a

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.org

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
* Sharedb-ace
2-
[[https://badge.fury.io/js/sharedb-ace.svg]]
2+
[[https://badge.fury.io/js/@sourceacademy%2Fsharedb-ace.svg]]
3+
4+
This is a fork of the [[https://github.com/jethrokuan/sharedb-ace][original sharedb-ace repository]].
35

46
Sharedb-ace provides two-way bindings between [[https://github.com/share/sharedb][ShareDB]] and [[http://ace.c9.io/][Ace Editor]].
57

68
** Installation
79
Using npm:
810

911
#+BEGIN_SRC sh
10-
npm install sharedb-ace
12+
npm install @sourceacademy/sharedb-ace
1113
#+END_SRC
1214

1315
Using pre-compiled js from unpkg CDN:
@@ -17,7 +19,6 @@ Using pre-compiled js from unpkg CDN:
1719
#+END_SRC
1820

1921
** Documentation
20-
Please see [[http://www.jethrokuan.com/sharedb-ace/][here]] for internals documentation.
2122

2223
*** Single Ace-editor Instance
2324
Setup the ShareDB document as a string:
@@ -52,9 +53,22 @@ git clone https://github.com/jethrokuan/sharedb-ace.git
5253
#+END_SRC
5354

5455
#+BEGIN_SRC sh
55-
cd sharedb-ace && npm install
56+
cd sharedb-ace && yarn install
57+
#+END_SRC
58+
59+
To test the package locally, run the following on this sharedb-ace repository:
60+
#+BEGIN_SRC sh
61+
yarn build
62+
yarn link
5663
#+END_SRC
5764

65+
Then, run the following on the frontend repository:
66+
#+BEGIN_SRC sh
67+
yarn link @sourceacademy/sharedb-ace
68+
#+END_SRC
69+
70+
Now, whenever you want to update the ShareDB Ace binding, simply run `yarn build`.
71+
5872
*** Generating JS Docs
5973
We generate javascript documentation using inline documentation.
6074

0 commit comments

Comments
 (0)