diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..25a1981 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,62 @@ +# Changelog + +Notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +Breaking changes (😱!!!): + +New features: + +Bugfixes: + +Other improvements: + +## [v4.1.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v4.1.1) - 2019-01-12 + +- Expand documentation + +## [v4.1.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v4.1.0) - 2018-09-09 + +- Export `null` and `notNull` (@bklaric) + +## [v4.0.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v4.0.0) - 2018-05-24 + +- Updated for PureScript 0.12 + +## [v3.0.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v3.0.0) - 2017-04-02 + +- Updates for 0.11 compiler + +## [v2.0.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v2.0.0) - 2016-10-17 + +- Updated dependencies + +## [v1.0.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v1.0.1) - 2016-06-13 + +- Fix `bower.json` (@kika) + +## [v1.0.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v1.0.0) - 2016-06-02 + +- Updates for 1.0 core libraries. + +## [v0.2.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.2.1) - 2015-07-24 + +- Fix `null` issue spotted by @Javran. + +## [v0.2.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.2.0) - 2015-06-30 + +- This release works with versions 0.7.\* of the PureScript compiler. It will not work with older versions. If you are using an older version, you should require an older, compatible version of this library. + +## [v0.2.0-rc.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.2.0-rc.1) - 2015-06-19 + +- Release for the 0.7 compiler. + +## [v0.1.1](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.1.1) - 2015-03-07 + +- Handle `undefined`. + +## [v0.1.0](https://github.com/purescript-contrib/purescript-nullable/releases/tag/v0.1.0) - 2015-01-29 + +- Initial release + diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 100% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md diff --git a/README.md b/README.md index fa75256..6b0ff84 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ The quick start hasn't been written yet (contributions are welcome!). The quick `nullable` documentation is stored in a few places: 1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-nullable). -2. Written documentation and [the changelog](./docs/CHANGELOG.md) are kept in [the docs directory](./docs). +2. Written documentation is kept in the [docs directory](./docs). 3. Usage examples can be found in [the test suite](./test). If you get stuck, there are several ways to get help: @@ -38,6 +38,6 @@ You can contribute to `nullable` in several ways: 1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-nullable/issues). We'll do our best to work with you to resolve or answer it. -2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./.github/CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions. +2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions. 3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the [PureScript Discourse](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed. diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md deleted file mode 100644 index bb34d86..0000000 --- a/docs/CHANGELOG.md +++ /dev/null @@ -1,15 +0,0 @@ -# Changelog - -Notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [Unreleased] - -Breaking changes (😱!!!): - -New features: - -Bugfixes: - -Other improvements: - -## [0.0.0] - 2020-01-01 diff --git a/docs/README.md b/docs/README.md index 1d30f7c..1bd4214 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,3 @@ # Nullable Documentation -This directory contains documentation for `nullable`. If you are interested in contributing new documentation, please read the [contributor guidelines](../.github/CONTRIBUTING.md) and [What Nobody Tells You About Documentation](https://documentation.divio.com) for help getting started. +This directory contains documentation for `nullable`. If you are interested in contributing new documentation, please read the [contributor guidelines](../CONTRIBUTING.md) and [What Nobody Tells You About Documentation](https://documentation.divio.com) for help getting started.