summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJens Georg <mail@jensge.org>2021-05-30 12:27:30 +0200
committerJens Georg <mail@jensge.org>2021-06-09 23:55:54 +0200
commit04d0def9b0803547163fbf3f3595b3dc905e6cd5 (patch)
tree6b4f44b6386c578e6158fd87a181f1916ae5a539 /README.md
parentf26b70a719272e85dcc6fdc1a0afc276ae5e106e (diff)
downloadgupnp-04d0def9b0803547163fbf3f3595b3dc905e6cd5.tar.gz
All: Move README to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f69b5aa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+GUPnP
+=====
+
+GUPnP is an object-oriented open source framework for creating UPnP devices and
+control points, written in C using GObject and libsoup. The GUPnP API is
+intended to be easy to use, efficient and flexible.
+
+The GUPnP framework consists of the following two libraries:
+
+ * GSSDP implements resource discovery and announcement over SSDP.
+
+ * GUPnP implements the UPnP specification: resource announcement and
+ discovery, description, control, event notification, and presentation
+ (GUPnP includes basic web server functionality through libsoup). GUPnP does
+ not include helpers for construction or control of specific standardized
+ resources (e.g. MediaServer); this is left for higher level libraries
+ utilizing the GUPnP framework.
+
+The GUPnP framework was born out of frustration with libupnp and its mess of
+threads. GUPnP is entirely single-threaded (though asynchronous), integrates
+with the GLib main loop, and provides the same set of features as libupnp while
+hiding most of the UPnP internals through an elegant object-oriented design.
+
+GUPnP is free software released under the GNU LGPL.