Skip to content

Commit

Permalink
moved logo files so that they are visible both in github/gitea and on…
Browse files Browse the repository at this point in the history
… hexdocs.pm
  • Loading branch information
waseigo committed Apr 30, 2023
1 parent bf2bad1 commit 981bc22
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@ def deps do
end
```

## Usage

Use [`VatchexGreece.new/4`](https://hexdocs.pm/vatchex_greece/VatchexGreece.html#new/4) with the target VAT ID plus your GSIS SOAP web service username, password, and source VAT ID associated with your authentication username and password (it's a legal requirement). This defines a clean new `%Results{}` struct containing the filled-in `%Auth{}` struct and the prepared `%GSISdata{}` struct. The `%Results{}` struct and its contents will be progressively filled in by the function calls within [`VatchexGreece.get/1`](https://hexdocs.pm/vatchex_greece/VatchexGreece.html#get/1).

## Improvements since v0.6.0

* Now compatible with the `RgWsPublic2` SOAP web service (new since 2023-04-20).
* Now possible to make SOAP API calls using different credentials in `%Auth{}` structs, e.g. for multi-tenant setups.
* Now needs no application setup in `config.exs` or `mix.exs`, thanks to getting rid of the [Soap](https://github.com/elixir-soap/soap) library due to parsing issues, and because it seems abandoned and not particularly robust to begin with.
* XML parsing is now handled directly with [SweetXml](https://hexdocs.pm/sweet_xml/SweetXml.html).
* Actual logging of errors in the `%Results{}` struct means you can find out what went wrong.
* Actual handling of errors (with `{:ok, ...}` and `{:error, ...}` tuples along the pipeline across all modules means that no API call or parsing of the XML response body is made unless no errors have popped up.

## Documentation

The docs can be found at <https://hexdocs.pm/vatchex_greece>.
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ defmodule VatchexGreece.MixProject do
docs: [
# The main page in the docs
main: "VatchexGreece",
logo: "./logo.png",
logo: "./assets/logo.png",
extras: ["README.md"]
]
]
Expand Down

0 comments on commit 981bc22

Please sign in to comment.