Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bodrovis committed Mar 18, 2021
1 parent f4747d1 commit 89e73ba
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ end
Put your Lokalise API token into `config.exs`:

```elixir
config :elixir_lokalise_api, api_token: "LOKALISE_API_TOKEN"
config :your_app, api_token: "LOKALISE_API_TOKEN"
```

If you are using ENV variables, use the following approach:

```elixir
config :elixir_lokalise_api, api_token: {:system, "LOKALISE_API_TOKEN"}
config :your_app, api_token: {:system, "LOKALISE_API_TOKEN"}
```

Now you can perform API calls:
Expand Down
3 changes: 3 additions & 0 deletions docs/additional_info/changelog.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# Changelog

## 1.0.0-rc.1 (18-Mar-2021)

* Initial release
6 changes: 2 additions & 4 deletions docs/api/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,20 @@ def deps do
end
```



## Initializing the Client

In order to perform API requests, you require a special token that can be obtained in your [personal profile](https://lokalise.com/profile#apitokens) (*API tokens* section).

After you've obtained the token, put it inside `config.exs`:

```elixir
config :elixir_lokalise_api, api_token: "LOKALISE_API_TOKEN"
config :your_app, api_token: "LOKALISE_API_TOKEN"
```

If you are using ENV variables, use the following approach:

```elixir
config :elixir_lokalise_api, api_token: {:system, "ENV_VARIABLE_NAME"}
config :your_app, api_token: {:system, "ENV_VARIABLE_NAME"}
```

Now you can send API requests!
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ end
Obtain Lokalise API token in your personal profile and put it into `config.exs`:

```elixir
config :elixir_lokalise_api, api_token: "LOKALISE_API_TOKEN"
config :your_app, api_token: "LOKALISE_API_TOKEN"
```

If you are using ENV variables, use the following approach:

```elixir
config :elixir_lokalise_api, api_token: {:system, "ENV_VARIABLE_NAME"}
config :your_app, api_token: {:system, "ENV_VARIABLE_NAME"}
```

Now you can perform API calls:
Expand Down

0 comments on commit 89e73ba

Please sign in to comment.