Skip to content

Commit 886a870

Browse files
committed
[docs] readme
1 parent 8c8c455 commit 886a870

File tree

3 files changed

+47
-68
lines changed

3 files changed

+47
-68
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
node_modules
22
*.swp
33
cov
4-
!ttest.js
4+
atest.js
55
notes

README.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Caronte
2+
=======
3+
4+
Caronte is an HTTP programmable proxying library that supports
5+
websockets. It is suitable for implementing components such as
6+
proxies and load balancers.
7+
8+
### Contributing and Issues
9+
10+
* Search on Google/Github
11+
* If you can't find anything, open an issue
12+
* If you feel comfortable about fixing the issue, fork the repo
13+
* Commit to your local branch (which must be different from `master`)
14+
* Submit your Pull Request (be sure to include tests and update documentation)
15+
16+
### Test
17+
18+
```
19+
$ npm test
20+
```
21+
22+
### License
23+
24+
```
25+
The MIT License (MIT)
26+
27+
Copyright (c) 2013 Nodejitsu Inc.
28+
29+
Permission is hereby granted, free of charge, to any person obtaining a copy
30+
of this software and associated documentation files (the "Software"), to deal
31+
in the Software without restriction, including without limitation the rights
32+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
33+
copies of the Software, and to permit persons to whom the Software is
34+
furnished to do so, subject to the following conditions:
35+
36+
The above copyright notice and this permission notice shall be included in
37+
all copies or substantial portions of the Software.
38+
39+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
40+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
41+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
42+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
43+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
44+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
45+
THE SOFTWARE.
46+
```

ttest.js

-67
This file was deleted.

0 commit comments

Comments
 (0)