Misc doc changes (izelnakri#117)

List of changes:

- Always use the latest ex_doc
- Sort deps
- Add source reference
- Set readme as default html page
- Add changelog to html doc
- Fix typos, indentation, and markdowns
- Update .gitignore
- Add editorconfig file
- Add license section
- Add project description section

Author:    Kian-Meng, Ang <[email protected]>
Date:      Sun Nov 29 20:13:44 2020 +0800

Author: kianmeng

.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# .editorconfig for Elixir projects
+# https://git.io/elixir-editorconfig
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{md, markdown, eex}]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

.gitignore

@@ -1,7 +1,26 @@
-/_build
-/cover
-/deps
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
 erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
 *.ez
-.elixir_ls
-.tool-versions
+
+# Ignore package tarball (built via "mix hex.build").
+paper_trail-*.tar
+
+# Temporary files for e.g. tests
+/tmp

CHANGELOG.md

@@ -1,3 +1,5 @@
+# Changelog
+
 ### v0.8.3 - September 10th, 2019:
 - PaperTrail.delete now accepts Ecto.Changeset
 

LICENSE.md

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2016 Izel Nakri
+Copyright (c) 2016-present Izel Nakri
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: