[#5] Improve documentation (#42)

* [#5] Improve documentation

* Update README.md

* Add cabal description

.ghci

@@ -1,3 +1,4 @@
 :set -XNoImplicitPrelude
 :set -XOverloadedStrings
+:set -XTypeApplications
 import Relude

.hlint.yaml

@@ -103,14 +103,6 @@
 
 - hint: {lhs: fmap (fmap f) x, rhs: f <<$>> x}
 
-- warn: {lhs: fmap concat (mapM f s), rhs: Relude.concatMapM f s}
-- warn: {lhs: concat <$> mapM f s, rhs: Relude.concatMapM f s}
-
-- warn: {lhs: fmap concat (forM f s), rhs: Relude.concatForM s f}
-- warn: {lhs: fmap concat (for f s), rhs: Relude.concatForM s f}
-- warn: {lhs: concat <$> forM f s, rhs: Relude.concatForM s f}
-- warn: {lhs: concat <$> for f s, rhs: Relude.concatForM s f}
-
 - hint: { lhs: fmap and (sequence s), rhs: Relude.andM s
         , note: "Applying this hint would mean that some actions\n that were being executed previously would no longer be executed." }
 - hint: { lhs: and <$> sequence s, rhs: Relude.andM s
@@ -389,10 +381,6 @@
 - warn: { name: "Use 'comparing' from Relude"
         , lhs: Data.Ord.comparing, rhs: Relude.comparing }
 
-- warn: { name: "Use 'fmapDefault' from Relude"
-        , lhs: Data.Traversable.fmapDefault, rhs: Relude.fmapDefault }
-- warn: { name: "Use 'foldMapDefault' from Relude"
-        , lhs: Data.Traversable.foldMapDefault, rhs: Relude.foldMapDefault }
 - warn: { name: "Use 'forM' from Relude"
         , lhs: Data.Traversable.forM, rhs: Relude.forM }
 - warn: { name: "Use 'mapAccumL' from Relude"
@@ -468,6 +456,8 @@
 
 - warn: { name: "Use 'Coercible' from Relude"
         , lhs: GHC.Types.Coercible, rhs: Relude.Coercible }
+- warn: { name: "Use 'coerce' from Relude"
+        , lhs: Data.Coerce.coerce, rhs: Relude.coerce }
 
 - warn: { name: "Use 'getStackTrace' from Relude"
         , lhs: GHC.ExecutionStack.getStackTrace, rhs: Relude.getStackTrace }

.travis.yml

@@ -1,7 +1,6 @@
 sudo: true
 language: haskell
 
-
 git:
   depth: 5
 
@@ -13,7 +12,6 @@ cache:
   - "$TRAVIS_BUILD_DIR/.stack-work"
 
 matrix:
-
   include:
 
   - ghc: 8.0.2

CHANGELOG.md

@@ -4,23 +4,15 @@ Change log
 0.1.0
 =====
 
-* [#8](https://github.com/kowainik/relude/issues/8):
-  Introduce `StaticMap` and `DynamicMap` type classes as universal interface for
-  Map-like structures.
-* [#14](https://github.com/kowainik/relude/issues/14):
-  Add `Relude.Extra.*` modules which are not exported by default but have useful
-  functions.
+* [#7](https://github.com/kowainik/relude/issues/7):
+  Remove `Container.Class.Container`. Export `Foldable`.
 * [#2](https://github.com/kowainik/relude/issues/2):
   Remove `microlens` from dependencies.
-* [#12](https://github.com/kowainik/relude/issues/12):
-  Remove `liquid-haskell` support.
 * [#10](https://github.com/kowainik/relude/issues/10):
   Remove `VarArg` module.
 * [#9](https://github.com/kowainik/relude/issues/9):
   Remove `safe-exceptions` from dependencies. Reexport `Exception` and
   `SomeException` from `Control.Exception` instead.
-* [#7](https://github.com/kowainik/relude/issues/7):
-  Remove `Container.Class.Container`. Export `Foldable`.
 * [#11](https://github.com/kowainik/relude/issues/11):
   Remove `TypeOps` module and `type-operators` dependency.
 * [#13](https://github.com/kowainik/relude/issues/13):
@@ -35,14 +27,22 @@ Change log
 * [#18](https://github.com/kowainik/relude/issues/18):
   Add `LazyStrict` type class for conversions.
 * `map` is not `fmap` anymore. Reexport `map` from `Data.List`
-* [#17](https://github.com/kowainik/relude/issues/17):
-  Add `foldMapA` and `foldMapM` functions.
+* [#12](https://github.com/kowainik/relude/issues/12):
+  Remove `liquid-haskell` support.
 * [#20](https://github.com/kowainik/relude/issues/20):
   Add `viaNonEmpty` function.
 * [#21](https://github.com/kowainik/relude/issues/21):
   Add `MonadFail` instance for `Either`.
+* [#17](https://github.com/kowainik/relude/issues/17):
+  Add `foldMapA` and `foldMapM` functions.
 * [#4](https://github.com/kowainik/relude/issues/4):
   Rename package to `Relude`.
+* [#14](https://github.com/kowainik/relude/issues/14):
+  Add `Relude.Extra.*` modules which are not exported by default but have useful
+  functions.
+* [#8](https://github.com/kowainik/relude/issues/8):
+  Introduce `StaticMap` and `DynamicMap` type classes as universal interface for
+  Map-like structures.
 
 `relude` uses [PVP Versioning][1].
 The change log is available [on GitHub][2].

CONTRIBUTING.md

@@ -2,20 +2,22 @@
 
 ## :wave: Greetings Traveler!
 
-I'm glad you're reading this, I really appreciate the effort you're
+We're glad you're reading this, we really appreciate the effort you're
 putting in. Thank you for your help in making this library awesome! :sparkles:
 
 ### How to contribute
 
 #### Report bugs or feature request
+
 If you have found any bugs or have proposals on how to make this project better,
 don't hesitate to create issues
 [here](https://github.com/kowainik/relude/issues/new) in free format.
 
 #### Create a PR
+
 We love receiving pull requests from everyone. But, please, don't create a PR
 without a corresponding issue. It's always better to discuss your future
-work first. Even if such an issue exist it's still better to express your willing
+work first. Even if such an issue exists it's still better to express your willing
 to do that issue under comment section. Thus you will show that you're doing
 that issue, and nobody else will accidentally do it in parallel with you. Furthermore you
 also can discuss the best way to implement that issue!
@@ -27,9 +29,11 @@ To get started with this you should first fork, then clone the repo:
 Make your changes and consider the following check list to go through before submitting your pull request.
 
 #### :white_check_mark: Check list
+
 - [ ] Project compiles
 - [ ] New/fixed features work as expected
 - [ ] Old features do not break after the change
+- [ ] `stylish-haskell` with config in this repo root was used to format code
 - [ ] _Recommended:_ Commit messages are in the proper format. If the commit
   addresses an issue start the first line of the commit with the issue number in
   square parentheses.