Skip to content

Commit 351f883

Browse files
committed
fixes #34 Update warnings about release
1 parent 62c3b5f commit 351f883

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

Diff for: CONTRIBUTING

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If you're thinking of contributing, here's what you should know.
2222

2323
# The remaining items below are consequences of the items above.
2424

25-
4. All code must pass go vet, and be go fmt compliant.
25+
4. All code must pass `go vet`, and be `go fmt` compliant.
2626

2727
5. New features should have tests, and the existing tests must continue
2828
to pass. We use the go test framework.
@@ -46,8 +46,8 @@ If you're thinking of contributing, here's what you should know.
4646
end of the AUTHORS file. (Please do this, particularly for non-trivial
4747
changes!)
4848

49-
10. Submit a github pull request. Ideally just one bug per PR if possible,
50-
and based upon the latest commit in the github master branch.
49+
10. Submit a GitHub pull request. Ideally just one bug per PR if possible,
50+
and based upon the latest commit in the GitHub master branch.
5151

5252
11. We may rebase your changes, including squashing multiple commits,
5353
or ask you to do so, if you have not followed the procedure above, or

Diff for: README.adoc

+3-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,9 @@ These are colloquially known as a "`nanomsg`".
2222
a|image::mangos.jpg[float="right"]
2323
|===
2424

25-
WARNING: THIS IS A WORK-IN-PROGRESS AND NOT READY FOR GENERAL USE YET.
26-
This represents version 2 of _mangos_, and contains breaking changes and
27-
rather different API. To use the the original version of _mangos_ please
28-
see https://github.com/nanomsg/mangos
25+
NOTE: This is version 2 of _mangos_, and contains breaking changes and
26+
rather different API in some circumstances relative to version 1. To use the
27+
original version of _mangos_ please see https://github.com/nanomsg/mangos
2928

3029
The modern C implemenation of the SP protocols is available as
3130
https://github.com/nanomsg/nng[__NNG™__].

0 commit comments

Comments
 (0)