You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-14Lines changed: 13 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -4,41 +4,40 @@ Interspecific
4
4
Interspecific is a .NET 4.5 embedded HTTP/REST server with a focus on simplicity and a secondary focus
5
5
on performance.
6
6
7
-
Socket processing is based on [(a fork of)](https://github.com/tekhedd/SocketHttpListener)[MediaBrowser/SocketHttpListener](https://github.com/MediaBrowser/SocketHttpListener).
8
-
This is similar to HttpListener-based implementations, but it has several advantages:
7
+
Sockets are handled by [a fork of](https://github.com/tekhedd/SocketHttpListener) MediaBrowser/SocketHttpListener.
8
+
The API is the same as standard HttpListener-based implementations, but it has several advantages:
9
9
10
10
- enables custom authentication headers (token based authentication)
11
11
- allows client software to listen on any port without admin priveleges
12
12
- does not require fiddling with the .NET framework's HTTP configuration. (This comes at the cost of .NET's built-in HTTPS support, but whether that is a disadvantage is debatable.)
13
13
14
14
## Features ##
15
15
16
-
- Embed a REST server in your application. Add attributes to your classes and methods to define resources and routes for managing traffic based on HTTP method and path info (using regular expressions).
- Logging. Logging is pluggable, but is also a bit of a work-in-progress.
20
-
21
-
## Versions ##
22
-
23
-
The currrent stable releases are in the "1.x" branch and are released with v1 versions. Stable releases do not remove deprecated features and only include bug fixes.
24
-
25
-
Unstable development is in branch "master", and these are currently released as version 2.x releases. The API may change and new features may be added. If you feel that you need unstable features backported to 1.x or would like to see 2.x feature frozen please open an issue. Or in fact just drop me a line if you're using the library.
16
+
- Embed a REST server in your application.
17
+
- REST path and URL parsing based on regular expressions, compiled for efficiency.
18
+
- Serve static files.
19
+
- Logging via the standard TraceSource mechanism.
26
20
27
21
## Available on NuGet ##
28
22
29
23
https://www.nuget.org/packages/Interspecific/
30
24
25
+
## Versions ##
26
+
27
+
The 2.x versions may be considered stable, and will not incorporate any breaking
28
+
changes. Stable branch maintenance is currently in the master branch.
29
+
31
30
## History ##
32
31
33
32
Interspecific started as a fork of Scott Offen's [Grapevine](https://github.com/scottoffen/Grapevine). It attempts to
34
33
retain the Grapevine goal of simplicity, while making adding some complexity to the core engine to make
35
-
the actual REST server code even simpler, and improve efficiency and manage worst case failure modes
36
-
under heavy load conditions in production deployments.
34
+
client code even simpler, improve efficiency, and manage worst case failure modes under heavy load conditions in production deployments.
37
35
38
36
## Contact ##
39
37
40
38
Submit bug reports and enhancements to Interspecific's Github Issues section.
41
39
42
40
## License ##
41
+
43
42
This project is licensed under the Apache License, V2.0.
44
43
Please see the LICENSE file at the root of this repository for details.
0 commit comments