docs: tidy up, improve generation

Author: kianmeng

.formatter.exs

@@ -1,4 +1,4 @@
 # Used by "mix format"
 [
-  inputs: ["mix.exs", "{config,lib,test}/**/*.{ex,exs}"]
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
 ]

.gitignore

@@ -22,5 +22,8 @@ erl_crash.dump
 # Ignore package tarball (built via "mix hex.build").
 toml-*.tar
 
+# Temporary files, e.g. from tests
+/tmp/
+
 # Ignore generated benchmark output
 /bench/output/

LICENSE

@@ -174,30 +174,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2012 Plataformatec
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   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.
-
-

README.md

@@ -1,12 +1,15 @@
 # TOML for Elixir
 
-[![Master](https://travis-ci.com/bitwalker/toml-elixir.svg?branch=master)](https://travis-ci.com/bitwalker/toml-elixir)
-[![Hex.pm Version](http://img.shields.io/hexpm/v/toml.svg?style=flat)](https://hex.pm/packages/toml)
+[![Main](https://github.com/bitwalker/toml-elixir/workflows/elixir/badge.svg?branch=main)](https://github.com/bitwalker/toml-elixir/actions?query=workflow%3A%22elixir%22+branch%3Amain)
+[![Hex.pm Version](https://img.shields.io/hexpm/v/toml.svg?style=flat)](https://hex.pm/packages/toml)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg?style=flat)](https://hexdocs.pm/toml)
+[![Total Download](https://img.shields.io/hexpm/dt/toml.svg?style=flat)](https://hex.pm/packages/toml)
+[![Last Updated](https://img.shields.io/github/last-commit/bitwalker/toml-elixir.svg?style=flat)](https://github.com/bitwalker/toml-elixir/commits/main)
 
-This is a TOML library for Elixir projects. It is compliant with version 0.5.0 of the
-[official TOML specification](https://github.com/toml-lang/toml). You can find a
-brief overview of the feature set below, but you are encouraged to read the full
-spec at the link above (it is short and easy to read!).
+This is a TOML library for Elixir projects. 
+
+It is compliant with version 1.0 of the [official TOML specification](https://github.com/toml-lang/toml). You can find a
+brief overview of the feature set below, but you are encouraged to read the full spec at the link above (it is short and easy to read!).
 
 ## Features
 
@@ -50,7 +53,7 @@ This library is available on Hex as `:toml`, and can be added to your deps like
 ```elixir
 def deps do
   [
-    {:toml, "~> 0.6.1"}
+    {:toml, "~> 0.7"}
   ]
 end
 ```
@@ -180,7 +183,7 @@ expected '\n', but got 'b' in nofile on line 2:
 Support for extending value conversions is provided by the `Toml.Transform`
 behavior. An example is shown below:
 
-Given the follwing TOML document:
+Given the following TOML document:
 
 ``` toml
 [servers.alpha]

lib/toml.ex

@@ -1,4 +1,6 @@
 defmodule Toml do
+  @external_resource "README.md"
+
   @moduledoc File.read!(Path.join([__DIR__, "..", "README.md"]))
 
   @type key :: binary | atom | term
@@ -20,12 +22,10 @@ defmodule Toml do
 
     * `:filename` - pass a filename to use in error messages
     * `:keys` - controls how keys in the document are decoded. Possible values are:
-
       * `:strings` (default) - decodes keys as strings
       * `:atoms` - converts keys to atoms with `String.to_atom/1`
       * `:atoms!` - converts keys to atoms with `String.to_existing_atom/1`
       * `(key -> term)` - converts keys using the provided function
-      
     * `:transforms` - a list of custom transformations to apply to decoded TOML values,
       see `c:Toml.Transform.transform/2` for details.
       

mix.exs

@@ -61,16 +61,21 @@ defmodule Toml.MixProject do
     [
       files: ["lib", "mix.exs", "README.md", "LICENSE"],
       maintainers: ["Paul Schoenfelder"],
-      licenses: ["Apache 2.0"],
+      licenses: ["Apache-2.0"],
       links: %{"GitHub" => @source_url}
     ]
   end
 
   defp docs do
     [
-      main: "Toml",
+      main: "readme",
       source_url: @source_url,
-      source_ref: @version
+      source_ref: @version,
+      extras: [
+        LICENSE: [title: "License"],
+        "README.md": [title: "Overview"]
+      ],
+      formatters: ["html"]
     ]
   end
 

test/fixtures/toml-test/valid/comments-everywhere.toml

@@ -7,7 +7,7 @@
 [group] # Comment
 answer = 42 # Comment
 # no-extraneous-keys-please = 999
-# Inbetween comment.
+# In between comment.
 more = [ # Comment
   # What about multiple # comments?
   # Can you handle it?