Permalink
Browse files

readme updates

  • Loading branch information...
1 parent 8eed101 commit 3ab731ffa20c0756e2f0449917564d9b33b59cd5 @ttezel committed Feb 28, 2013
Showing with 3 additions and 14 deletions.
  1. +3 −14 readme.md
View
@@ -17,11 +17,11 @@ writeme
###Example
-Given the following code:
+Code should be documented similar to the example below:
```javascript
/**
- * Here I describe what my function does.
+ * Here I describe what this function does.
*
* @param {string} baz baz description
* @return {boolean} bool description
@@ -31,20 +31,9 @@ Class.prototype.publicMethod = function (baz) {
}
```
-`Writeme` generates:
-
-
-###function Class.publicMethod(baz)
- `baz`: **string** baz description
-
-return : **boolean** bool description
-
-
-<p>Here I describe what my function does.</p>
-
-----
-To see further examples of what `writeme`-generated documentation looks like, check out `api.md` and `api.html` at the root of this repo, or the examples inside the `examples` directory.
+To see examples of what `writeme`-generated documentation looks like, check out [api.md](https://github.com/ttezel/writeme/blob/master/api.md) and [api.html](https://github.com/ttezel/writeme/blob/master/api.html) at the root of this repo, or the examples inside the **examples** directory.
## License

0 comments on commit 3ab731f

Please sign in to comment.