Skip to content

Commit

Permalink
Merge pull request #6 from nautobot/u/snaselj-fix-readme
Browse files Browse the repository at this point in the history
Fix documentation
  • Loading branch information
cmsirbu authored Feb 22, 2024
2 parents 2e8ad02 + e7f6581 commit 046894f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Nautobot Dev Example App

This application serves as a testbed for evaluating improvements to the [Nautobot App Cookiecutter Templates](https://github.com/nautobot/cookiecutter-nautobot-app). **DO NOT USE** this repository directly in production environments or to bootstrap a new app!

For those wanting to develop a new Nautobot app, please use the [cookiecutter template](https://github.com/nautobot/cookiecutter-nautobot-app) as a starting point.

<p align="center">
<img src="https://raw.githubusercontent.com/nautobot/nautobot-app-dev-example/develop/docs/images/icon-nautobot-dev-example.png" class="logo" height="200px">
<br>
Expand All @@ -16,7 +20,6 @@
An example Nautobot app with multiple functions:

- Acts as a Canary App to test enhancements to the Nautobot app [cookiecutter templates](https://github.com/nautobot/cookiecutter-nautobot-app).
- Offers a starting point for developing new apps.
- Illustrates how to use the Nautobot app framework.

### Screenshots
Expand Down
1 change: 1 addition & 0 deletions changes/6.housekeeping
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed the documentation to explain the app usage.
5 changes: 1 addition & 4 deletions docs/dev/extending.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Extending the App

!!! warning "Developer Note - Remove Me!"
Information on how to extend the App functionality.

Extending the application is welcome, however it is best to open an issue first, to ensure that a PR would be accepted and makes sense in terms of features and design.
This app is designed to be an internal tool for testing and development purposes.

0 comments on commit 046894f

Please sign in to comment.