Permalink
Browse files

Added documentation for as well as adjusted the url to the experiment…

…al-fallbacks branch.
  • Loading branch information...
1 parent 7d186d0 commit 6218491618429a77ff8ac7b3687bdadb7e525cdf @xavi- committed Sep 3, 2012
Showing with 3 additions and 1 deletion.
  1. +3 −1 README.markdown
View
@@ -9,6 +9,8 @@ When `require("copy-paste")` is executed, two global functions are added:
- `copy(text)`: asynchronously replaces the current contents of the clip board with `text`. Takes either a string, array, object, or readable stream.
- `paste()`: synchronously returns the current contents of the system clip board.
+If you do not want to pollute the global namespaced call `require("copy-paste").noConflict()`. It'll remove the `copy` and `paste` global functions as well as return an object that has `copy` and `paste` properties.
+
## Getting node-copy-paste
The easiest way to get node-copy-paste is with [npm](http://npmjs.org/):
@@ -23,7 +25,7 @@ Alternatively you can clone this git repository:
## Future plans
-I'm hoping to add various fallbacks for instances when `xclip` or `clip` is not avaiable (see [experimental-fallbacks](https://github.com/xavi-/node-copy-paste/tree/experimental-fallbacks) branch). Also this library needs to be more thoroughly tested on windows.
+I'm hoping to add various fallbacks for instances when `xclip` or `clip` is not avaiable (see [experimental-fallbacks](https://github.com/xavi-/node-copy-paste/tree/experimental-fallbacks/platform) branch). Also this library needs to be more thoroughly tested on windows.
## Developed by
* Xavi Ramirez

0 comments on commit 6218491

Please sign in to comment.