diff --git a/.gitignore b/.gitignore index 25c8fdb..c2658d7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1 @@ -node_modules -package-lock.json \ No newline at end of file +node_modules/ diff --git a/LICENSE b/LICENSE.txt similarity index 99% rename from LICENSE rename to LICENSE.txt index 261eeb9..d645695 100644 --- a/LICENSE +++ b/LICENSE.txt @@ -1,3 +1,4 @@ + Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ diff --git a/README.md b/README.md index 8ee817f..20a8ff7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ -# proxmox-ve-openapi -An OpenAPI Spec for the ProxMox VE Rest API +# Proxmox VE OpenAPI + +Generate OpenAPI spec from Proxmox VE REST API. + +[![Apache 2.0 License][apache-badge]][apache-url] +[![Discord Chat][discord-badge]][discord-url] + +[apache-badge]: https://img.shields.io/badge/license-Apache%202.0-blue.svg +[apache-url]: https://github.com/tribufu-forks/proxmox-ve-openapi/blob/master/LICENSE.txt +[discord-badge]: https://img.shields.io/discord/276504514616623104.svg?logo=discord&style=flat-square +[discord-url]: https://www.tribufu.com/discord + +[Website](https://www.tribufu.com) | +[Discord](https://www.tribufu.com/discord) + +## Credits + +This project was forked from: [LUMASERV/proxmox-ve-openapi]. + +[LUMASERV/proxmox-ve-openapi]: https://github.com/LUMASERV/proxmox-ve-openapi + +## License + +This project is licensed under the [Apache License 2.0]. + +[Apache License 2.0]: https://github.com/tribufu-forks/proxmox-ve-openapi/blob/master/LICENSE.txt