Refactoring the markdown to pass linting steps

What does this commit/MR/PR do ?

- Refactoring the markdown to pass linting steps

Why is this commit/MR/PR needed ?

- linting helps consistency

Author: stephenmoloney

.remarkrc

@@ -23,7 +23,7 @@
     ["remark-lint-no-file-name-consecutive-dashes"],
     ["remark-lint-no-file-name-outer-dashes"],
     ["remark-lint-no-consecutive-blank-lines"],
-    ["remark-lint-maximum-line-length", "100"],
+    ["remark-lint-maximum-line-length", 100],
     ["remark-lint-no-shell-dollars"],
     ["remark-lint-heading-style", "atx"],
     ["remark-lint-heading-increment"],

CHANGELOG.md

@@ -1,13 +1,24 @@
 # Changelog
 
-## v1.0.1
+## v2.0.0
+
+-   Relax the requirements for `scrivener_ecto` to allow 1.x and 2.x
+versions - thereby also allowing ecto 3.x,
+resolves [issue 4](https://github.com/stephenmoloney/scrivener_list/issues/4)
+
+-   README example without a Repo module no longer references
+a Repo module confusingly - [PR](https://github.com/stephenmoloney/scrivener_list/pull/2)
 
-[fixes]
-- Cannot pass %Scrivener.Config.t into `Scrivener.Repo.paginate`. Change docs to reflect this.
-- Add `:scrivener_ecto` to `applications` and hence quieten warnings for releases.
-- bump dependencies & fix warnings for elixir 1.4.
+-   Formatting introduced with `mix format`
+
+-   Linting the README.md file
+
+## v1.0.1
 
+-   Cannot pass %Scrivener.Config.t into `Scrivener.Repo.paginate`. Change docs to reflect this.
+-   Add `:scrivener_ecto` to `applications` and hence quieten warnings for releases.
+-   bump dependencies & fix warnings for elixir 1.4.
 
 ## v1.0
 
-- Initial release.
+-   Initial release.

README.md

@@ -5,29 +5,30 @@ allows the pagination of a list of elements.
 
 ## Features 
 
-  1. Scrivener.List extends the protocol `Scrivener.Paginater.paginate/2` from the [scrivener](https://github.com/drewolson/scrivener) library.
-  2. Scrivener.List also extends the function `MyApp.Repo.paginate/2` from the [scrivener_ecto](https://github.com/drewolson/scrivener_ecto) library.
+1.  Scrivener.List extends the protocol `Scrivener.Paginater.paginate/2` from the [scrivener](https://github.com/drewolson/scrivener) library.
+1.  Scrivener.List also extends the function `MyApp.Repo.paginate/2` from the [scrivener_ecto](https://github.com/drewolson/scrivener_ecto) library.
 
-Using the second feature is entirely optional. It is provided as a convenience where the [scrivener_ecto](https://github.com/drewolson/scrivener_ecto) 
-library is also being used in the project and gives access to the pre-configured `MyApp.Repo` module.
-
+Using the second feature is entirely optional. It's provided as a convenience where the [scrivener_ecto](https://github.com/drewolson/scrivener_ecto)
+library is also being used in the project and gives access to the
+pre-configured `MyApp.Repo` module.
 
 ## Usage
 
 ## 1. Usage without a Repo module 
 
+```elixir
+Scrivener.paginate(list, config)
+```
 
-### Function 
-
-```Scrivener.paginate(list, config)```
+### Arguments (without a repo)
 
-### Arguments
+-   ```list```: A list of elements to be paginated
 
-- ```list```: A list of elements to be paginated
-- ```config```: A configuration object with the pagination details. Can be in any of the following formats:
-     - ```%{page: page_number, page_size: page_size}``` (map)
-     - ```[page: page_number, page_size: page_size]``` (Keyword.t)
-     - ```%Scrivener.Config{page_number: page_number, page_size: page_size}``` (Scrivener.Config.t)
+-   ```config```: A configuration object with the pagination details.
+    Can be in any of the following formats:
+    -   ```%{page: page_number, page_size: page_size}``` (map)
+    -   ```[page: page_number, page_size: page_size]``` (Keyword.t)
+    -   ```%Scrivener.Config{page_number: page_number, page_size: page_size}``` (Scrivener.Config.t)
 
 `max_page_size` **cannot** be configured with method 1.
 
@@ -55,8 +56,7 @@ defp maybe_put_default_config(%{page: page_number, page_size: page_size} = param
 defp maybe_put_default_config(_params), do: %Scrivener.Config{page_number: 1, page_size: 10}
 ```
 
-
-```elixir  
+```elixir
 list = ["C#", "C++", "Clojure", "Elixir", "Erlang", "Go", "JAVA", "JavaScript", "Lisp",
         "PHP", "Perl", "Python", "Ruby", "Rust", "SQL"]
 
@@ -66,7 +66,6 @@ Scrivener.paginate(list, %{page: 1, page_size: 4}) # map
 Scrivener.paginate(list, %{page: 1}) # map with only page number (page_size defaults to 10)
 ```
 
-
 ## 2. Usage with a Repo module
 
 Usage without a Repo is entirely optional and is added to `Scrivener.List` for convenience. 
@@ -81,24 +80,25 @@ defmodule MyApp.Repo do
 end
 ```
 
-### Function 
+```elixir
+MyApp.Repo.paginate(list, config)
+```
 
-```MyApp.Repo.paginate(list, config)```
+### Arguments (with a repo)
 
-### Arguments
+-   ```list```: A list of elements to be paginated
 
-- ```list```: A list of elements to be paginated
-- ```config```: A configuration object with the pagination details. Can be in any of the following formats:
-     - ```%{page: page_number, page_size: page_size}``` (map)
-     - ```[page: page_number, page_size: page_size]``` (Keyword.t)
+-   ```config```: A configuration object with the pagination details.
+    Can be in any of the following formats:
+    -   ```%{page: page_number, page_size: page_size}``` (map)
+    -   ```[page: page_number, page_size: page_size]``` (Keyword.t)
 
 `max_page_size` **can** be configured with method 1. See [Scrivener.Ecto](https://github.com/drewolson/scrivener_ecto).
 
 ### Example
 
 Example based on [scrivener_ecto](https://github.com/drewolson/scrivener_ecto) readme.
 
-
 ```elixir
 def index(conn, params) do
   %{age: age, name: name} = params["search"] 
@@ -120,7 +120,6 @@ def index(conn, params) do
 end
 ```
 
-
 ## Installation
 
 Add [scrivener_list](https://hex.pm/packages/scrivener_list) to your list of dependencies in `mix.exs`:
@@ -133,18 +132,17 @@ def deps do
 end
 ```
 
-
 ## Tests
 
 ```shell
 mix test
 ```
 
-
 ## Acknowledgements
 
-Thanks to [Drew Olson](https://github.com/drewolson) for helping with this, particularly the introduction of the [protocol](http://blog.drewolson.org/extensible-design-with-protocols/).
-
+The introduction of the [protocol](http://blog.drewolson.org/extensible-design-with-protocols/)
+for scrivener enabled the separation of this package into it's own
+repository.
 
 ## Licence