Misc doc changes (michalmuskala#126)

List of changes:

- Fix typo
- Add changelog to html doc
- Fix indentation in changelog
- Embed license file to html doc
- Update license copyright year
- Use common source url
- Use latest available ex_doc version

Author: kianmeng

CHANGELOG.md

@@ -12,15 +12,15 @@
 
 * Fix `html_safe` escaping in `Jason.encode`
 
-The `<!--` sequence of characters would not be escaped in `Jason.encode`
-with`html_escape` mode, which could lead to DoS attacks when used for
-embedding of arbitrary, user controlled strings into HTML through JSON
-(e.g. inside of `<script>` tags).
+  The `<!--` sequence of characters would not be escaped in `Jason.encode`
+  with`html_escape` mode, which could lead to DoS attacks when used for
+  embedding of arbitrary, user controlled strings into HTML through JSON
+  (e.g. inside of `<script>` tags).
 
-If you were not using the `html_safe` option, you are not affected.
+  If you were not using the `html_safe` option, you are not affected.
 
-Affected versions: < 1.2.1
-Patched versions: >= 1.2.1
+  Affected versions: < 1.2.1
+  Patched versions: >= 1.2.1
 
 ## 1.2.0 (17.03.2020)
 
@@ -91,4 +91,4 @@ No changes
 
 ## 1.0.0-rc.1 (22.12.2017)
 
-Initial release
+* Initial release

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017 Michał Muskała
+Copyright (c) 2017-present Michał Muskała
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -10,4 +10,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.

lib/formatter.ex

@@ -3,7 +3,7 @@ defmodule Jason.Formatter do
   Pretty-printing and minimizing functions for JSON-encoded data.
 
   Input is required to be in an 8-bit-wide encoding such as UTF-8 or Latin-1
-  in `t:iodata/0` format. Input must ve valid JSON, invalid JSON may produce
+  in `t:iodata/0` format. Input must have valid JSON, invalid JSON may produce
   unexpected results or errors.
   """
 

mix.exs

@@ -1,6 +1,7 @@
 defmodule Jason.Mixfile do
   use Mix.Project
 
+  @source_url "https://github.com/michalmuskala/jason"
   @version "1.2.2"
 
   def project() do
@@ -29,7 +30,7 @@ defmodule Jason.Mixfile do
     [
       {:decimal, "~> 1.0 or ~> 2.0", optional: true},
       {:dialyxir, "~> 1.0", only: [:dev, :test], runtime: false},
-      {:ex_doc, "~> 0.18", only: :dev, runtime: false},
+      {:ex_doc, ">= 0.0.0", only: :dev, runtime: false},
     ] ++ maybe_stream_data()
   end
 
@@ -58,7 +59,7 @@ defmodule Jason.Mixfile do
     [
       maintainers: ["Michał Muskała"],
       licenses: ["Apache-2.0"],
-      links: %{"GitHub" => "https://github.com/michalmuskala/jason"}
+      links: %{"GitHub" => @source_url}
     ]
   end
 
@@ -68,10 +69,8 @@ defmodule Jason.Mixfile do
       name: "Jason",
       source_ref: "v#{@version}",
       canonical: "http://hexdocs.pm/jason",
-      source_url: "https://github.com/michalmuskala/jason",
-      extras: [
-        "README.md"
-      ]
+      source_url: @source_url,
+      extras: ["README.md", "CHANGELOG.md", "LICENSE"]
     ]
   end
 end