Skip to content

Commit

Permalink
Provide documentation for extended packages
Browse files Browse the repository at this point in the history
`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.
  • Loading branch information
eborden committed Jun 9, 2019
1 parent 2b0b774 commit 36cc62d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion network.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -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@.
Expand Down

0 comments on commit 36cc62d

Please sign in to comment.