From 36cc62d7c0254839b36afd9a6bb7d366b97c516f Mon Sep 17 00:00:00 2001 From: Evan Rutledge Borden Date: Sun, 9 Jun 2019 17:11:37 -0500 Subject: [PATCH] Provide documentation for extended packages `network` does not seek to be an end all be all to all networking needs. Instead it seeks to be a cross-platform core. Other packages can be used to extend this core for platform specific APIs. This commit provides documentation of this fact for future users. --- network.cabal | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/network.cabal b/network.cabal index 4982c473..bba7a519 100644 --- a/network.cabal +++ b/network.cabal @@ -15,7 +15,11 @@ description: * hookup * network-simple . - === Related Packages + === Extended Packages + @network@ seeks to provide a cross-platform core for networking. As such some + APIs live in extended libraries. Packages in the @network@ ecosystem are + often prefixed with @network-@. + . ==== @network-bsd@ In @network-3.0.0.0@ the @Network.BSD@ module was split off into its own package, @network-bsd-3.0.0.0@.