Skip to content

Commit

Permalink
added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
muremwa committed Oct 8, 2020
1 parent afe8296 commit 6121abc
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Jump to:
[Usage](#usage).
[Custom Url configurations](#custom-url-configurations).
[Creating Custom Url configurations](#creating-custom-configurations).
[Using `ModelAdmin` urls](#modeladmin-urls).

- - -

Expand Down Expand Up @@ -66,6 +67,9 @@ Each app entry, in the array of apps, is an object with two properties:

4. `hasArgs` __[Boolean]__: `false` if `arguments` / entry 2 above is empty and vice versa.


To load changes click the reload button.

- - -
### Example in a `*.conf.json` file:
```JSON
Expand Down Expand Up @@ -113,6 +117,21 @@ Each app entry, in the array of apps, is an object with two properties:
> Incase of incorrect configurations, the file is ignored.
> [Check out the admin configurations file🧐.](extraUrls/admin.conf.json)
- - -
## `ModelAdmin` URLs.
To use your admin models URL, add an object in `.vscode/urlConfigs/models.json` with properties as app_labels _(peak into `apps.py`)_ and a list of model names.

To load changes click the reload button.

_Changes to detect models automatically are in development._
```JSON
{
"app_label": ["model1", "model2"],
"app_label_2": ["model3"]
}
```
- - -

## MISC
Created by [Muremwa](https://github.com/muremwa/).
Released under the [MIT License](LICENSE).

0 comments on commit 6121abc

Please sign in to comment.