Skip to content

Commit 90d2fab

Browse files
robertoaloimeta-codesync[bot]
authored andcommitted
Minor tweaks to README and ex_doc configuration
Summary: * Set `README` as the documentation entry point * Include `LICENSE` file in `ex_doc` documentation * Add explicit copyright to `README` * Add links to terms of use and privacy policy * Remove link to Contributing section (contribution guidelines live in `.github` and are already rendered by GitHub * Remove obsolete reference to release process Reviewed By: alanz Differential Revision: D85038135 fbshipit-source-id: e6126f8ac25effce189d2d0ec0f35a779fc423ad
1 parent 2a0317f commit 90d2fab

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,14 @@ To add `assert` to your rebar3 project, simply add it to the `deps` in your `reb
149149

150150
`assert` requires Erlang/OTP 26.
151151

152-
## Join the assert community
153-
See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.
152+
## License
153+
`assert` is Apache 2.0 licensed, as found in the [LICENSE](LICENSE.md) file.
154154

155-
## Release Process
155+
## References
156156

157-
The [release process](./RELEASE.md) requires a few steps, updating the [CHANGELOG.md](./CHANGELOG.md), releasing to [hex](https://hex.pm/packages/erlfmt) and more.
157+
* [Terms of Use](https://opensource.fb.com/legal/terms)
158+
* [Privacy Policy](https://opensource.fb.com/legal/privacy)
158159

159-
## License
160-
`assert` is Apache 2.0 licensed, as found in the [LICENSE](LICENSE.md) file.
160+
## Copyright
161+
162+
Copyright © Meta Platforms, Inc

rebar.config

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,8 @@
5050

5151
% We select `ex_doc` as the documentation provider. This renders documentation in Elixir style, as opposed to the old Erlang EDoc style.
5252
{hex, [{doc, ex_doc}]}.
53+
54+
{ex_doc, [
55+
{extras, [~"README.md", ~"LICENSE.md"]},
56+
{main, ~"README.md"}
57+
]}.

0 commit comments

Comments
 (0)