Update README.md

This commit is contained in:
Tony Roy 2021-03-13 13:54:13 -04:00 committed by GitHub
commit fee417f8bc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,8 +1,13 @@
## Laravel NetBox ## Laravel NetBox
NetBox is an open source web application designed to help manage and document computer networks. NetBox is an open source web application designed to help manage and document computer networks.
### Table of contents ### Table of contents
- [Installation](INSTALL.md)
- [Usage](#usage) - [Usage](#usage)
- [Commands](#commands) - [Commands](#commands)
- [Change log](CHANGELOG.md)
- [License](LICENSE.md)
-
### Usage ### Usage
#### Authentication [users] #### Authentication [users]
It's possible to use a custom `netbox` authentication driver to login users in your application, by default the UserProfile will be cached for 60 minutes It's possible to use a custom `netbox` authentication driver to login users in your application, by default the UserProfile will be cached for 60 minutes
@ -20,6 +25,7 @@ if(Auth::attempt(['username' => $username, 'password' => $password]))
dd(Auth::user(), Auth::id()); dd(Auth::user(), Auth::id());
} }
``` ```
#### Multiple Installs [config] #### Multiple Installs [config]
If you want to work with more Netbox installs, you can define more netboxes in the `config/netbox.php` file If you want to work with more Netbox installs, you can define more netboxes in the `config/netbox.php` file
```php ```php
@ -38,6 +44,7 @@ If you want to work with more Netbox installs, you can define more netboxes in t
], ],
``` ```
#### Multiple Installs [normal usage] #### Multiple Installs [normal usage]
To use another netbox than your default one, you can specify it with the panel-method To use another netbox than your default one, you can specify it with the panel-method
```php ```php
@ -51,6 +58,7 @@ public function getIndex()
// //
} }
``` ```
#### Multiple Installs [dependency injection] #### Multiple Installs [dependency injection]
```php ```php
// Route // Route