Browse files

Update README with notice about external adapters

Adapters shouldn't add hubot as a dependency in their package.json files.
This caused an issue when sending messages between hubot and the adapter.
  • Loading branch information...
1 parent 57be565 commit 9466a0a2845a2d1453984edab607b3544d33b87a @tombell tombell committed Dec 3, 2011
Showing with 5 additions and 2 deletions.
  1. +5 −2 README.md
View
7 README.md
@@ -29,8 +29,11 @@ directory will need to have ownership claimed preferably by the original
contributor.
1. Start a project for the hubot adapter npm package
-2. Add `hubot` 2.0 as a dependency to your `package.json` file
-3. Add your main adapter file as the `main` file in `package.json`
+2. Add your main adapter file as the `main` file in `package.json`
+
+**NOTE**: If you've already released an adapter, remove the hubot dependecy
+from the `package.json` file as this causes hubot to be installed twice
+causes some issues.
Below is an example of requiring hubot to extend `Adapter` and exporting
a `use` function that will be used to load your adapter when used.

0 comments on commit 9466a0a

Please sign in to comment.