Skip to content
This repository was archived by the owner on Dec 26, 2025. It is now read-only.

Commit 24b1ff0

Browse files
committed
Improve README and add MIT license
1 parent 8be349c commit 24b1ff0

File tree

2 files changed

+47
-4
lines changed

2 files changed

+47
-4
lines changed

LICENSE

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2014 Carl Lerche and other MIO contributors
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in
11+
all copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
1-
# MIO - Mini IO
1+
# MIO - Metal IO
22

3-
A lightweight non-blocking IO library for Rust.
3+
MIO is a lightweight IO library for Rust with a focus on adding as
4+
little overhead as possible over the OS abstractions.
45

5-
## Summary
6+
## Features
67

7-
Uses the reactor pattern.
8+
* Event loop backed by epoll, kqueue.
9+
* Zero allocations at runtime
10+
* Non-blocking TCP sockets
11+
* High performance timer system
12+
* Thread safe message channel for cross thread communication
13+
14+
__Coming soon__
15+
16+
* UDP and Unix domain sockets
17+
* Signal handling
18+
19+
## Non goals
20+
21+
The following are specifically omitted from MIO and are left to the user
22+
or higher level libraries.
23+
24+
* File operations
25+
* Thread pools / multi-threaded reactor
26+
27+
## Platforms
28+
29+
Currently, MIO only supports Linux and Darwin. However, Windows support
30+
will be coming soon. The goal is to support all platforms that Rust
31+
supports.

0 commit comments

Comments
 (0)