Permalink
Browse files

Added notes about installation and contribution.

  • Loading branch information...
1 parent 76cec37 commit 5aeb516667f4673025ee616a096aa2bcbc1027b0 @magnars magnars committed Oct 3, 2012
Showing with 34 additions and 0 deletions.
  1. +17 −0 README.md
  2. +17 −0 readme-template.md
View
@@ -2,6 +2,14 @@
The long lost Emacs string manipulation library.
+## Installation
+
+It's available on [marlamade](http://marmalade-repo.org/):
+
+ M-x package-install s
+
+Or you can just dump `s.el` in your load path somewhere.
+
## Functions
* [s-trim](#s-trim-s) `(s)`
@@ -259,6 +267,15 @@ Convert `s` to Capitalized Words.
```
+## Contribute
+
+Yes, please do. There's a suite of tests, so remember to add tests for your
+specific feature, or I might break it later.
+
+You'll find the repo at:
+
+ https://github.com/magnars/s.el
+
## Development
Run the tests with
View
@@ -2,6 +2,14 @@
The long lost Emacs string manipulation library.
+## Installation
+
+It's available on [marlamade](http://marmalade-repo.org/):
+
+ M-x package-install s
+
+Or you can just dump `s.el` in your load path somewhere.
+
## Functions
[[ function-list ]]
@@ -10,6 +18,15 @@ The long lost Emacs string manipulation library.
[[ function-docs ]]
+## Contribute
+
+Yes, please do. There's a suite of tests, so remember to add tests for your
+specific feature, or I might break it later.
+
+You'll find the repo at:
+
+ https://github.com/magnars/s.el
+
## Development
Run the tests with

0 comments on commit 5aeb516

Please sign in to comment.