mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
README Updates (#5084)
* Update funding.yml * Cleanup README.md * More cleanup
This commit is contained in:
parent
7f5e844367
commit
3001471706
1
.github/FUNDING.yml
vendored
1
.github/FUNDING.yml
vendored
@ -1,3 +1,4 @@
|
|||||||
github: inventree
|
github: inventree
|
||||||
ko_fi: inventree
|
ko_fi: inventree
|
||||||
patreon: inventree
|
patreon: inventree
|
||||||
|
custom: ["https://paypal.me/inventree?locale.x=en_AU", paypal]
|
||||||
|
59
README.md
59
README.md
@ -34,27 +34,14 @@
|
|||||||
<!-- About the Project -->
|
<!-- About the Project -->
|
||||||
## :star2: About the Project
|
## :star2: About the Project
|
||||||
|
|
||||||
InvenTree is an open-source Inventory Management System which provides powerful low-level stock control and part tracking. The core of the InvenTree system is a Python/Django database backend which provides an admin interface (web-based) and a REST API for interaction with external interfaces and applications.
|
InvenTree is an open-source Inventory Management System which provides powerful low-level stock control and part tracking. The core of the InvenTree system is a Python/Django database backend which provides an admin interface (web-based) and a REST API for interaction with external interfaces and applications. A powerful plugin system provides support for custom applications and extensions.
|
||||||
|
|
||||||
InvenTree is designed to be lightweight and easy to use for SME or hobbyist applications, where many existing stock management solutions are bloated and cumbersome to use. Updating stock is a single-action process and does not require a complex system of work orders or stock transactions.
|
Check out [our website](https://inventree.org) for more details.
|
||||||
|
|
||||||
Powerful business logic works in the background to ensure that stock tracking history is maintained, and users have ready access to stock level information.
|
|
||||||
|
|
||||||
<!-- Features -->
|
|
||||||
|
|
||||||
### :dart: Features
|
|
||||||
|
|
||||||
- Organize Parts and BOMs
|
|
||||||
- Manage Suppliers
|
|
||||||
- Instant Stock Knowledge
|
|
||||||
- Extend and Customize to fit your usage
|
|
||||||
|
|
||||||
<!-- Roadmap -->
|
<!-- Roadmap -->
|
||||||
### :compass: Roadmap
|
### :compass: Roadmap
|
||||||
|
|
||||||
* [x] Plugins
|
Want to see what we are working on? Check out the [roadmap tag](https://github.com/inventree/InvenTree/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap) and [horizon milestone](https://github.com/inventree/InvenTree/milestone/42).
|
||||||
* [ ] Improved Importers
|
|
||||||
* [ ] Custom Workflow Processes
|
|
||||||
|
|
||||||
<!-- Integration -->
|
<!-- Integration -->
|
||||||
### :hammer_and_wrench: Integration
|
### :hammer_and_wrench: Integration
|
||||||
@ -110,23 +97,7 @@ InvenTree is designed to be **extensible**, and provides multiple options for **
|
|||||||
</details>
|
</details>
|
||||||
|
|
||||||
<!-- Getting Started -->
|
<!-- Getting Started -->
|
||||||
## :toolbox: Getting Started
|
## :toolbox: Deployment / Getting Started
|
||||||
|
|
||||||
Refer to the [getting started guide](https://docs.inventree.org/en/latest/start/install/) for installation and setup instructions.
|
|
||||||
|
|
||||||
<!-- Mobile App -->
|
|
||||||
## :iphone: Mobile App
|
|
||||||
|
|
||||||
InvenTree is supported by a [companion mobile app](https://docs.inventree.org/en/latest/app/app/) which allows users access to stock control information and functionality.
|
|
||||||
|
|
||||||
<div align="center"><h4>
|
|
||||||
<a href="https://play.google.com/store/apps/details?id=inventree.inventree_app">Android Play Store</a>
|
|
||||||
<span> · </span>
|
|
||||||
<a href="https://apps.apple.com/au/app/inventree/id1581731101#?platform=iphone">Apple App Store</a>
|
|
||||||
</h4></div>
|
|
||||||
|
|
||||||
<!-- Deploy -->
|
|
||||||
## :train: Deploy
|
|
||||||
|
|
||||||
There are several options to deploy InvenTree.
|
There are several options to deploy InvenTree.
|
||||||
|
|
||||||
@ -143,25 +114,33 @@ Single line install - read [the docs](https://docs.inventree.org/en/latest/start
|
|||||||
wget -qO install.sh https://get.inventree.org && bash install.sh
|
wget -qO install.sh https://get.inventree.org && bash install.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Refer to the [getting started guide](https://docs.inventree.org/en/latest/start/install/) for a full set of installation and setup instructions.
|
||||||
|
|
||||||
|
<!-- Mobile App -->
|
||||||
|
## :iphone: Mobile App
|
||||||
|
|
||||||
|
InvenTree is supported by a [companion mobile app](https://docs.inventree.org/en/latest/app/app/) which allows users access to stock control information and functionality.
|
||||||
|
|
||||||
|
<div align="center"><h4>
|
||||||
|
<a href="https://play.google.com/store/apps/details?id=inventree.inventree_app">Android Play Store</a>
|
||||||
|
<span> · </span>
|
||||||
|
<a href="https://apps.apple.com/au/app/inventree/id1581731101#?platform=iphone">Apple App Store</a>
|
||||||
|
</h4></div>
|
||||||
|
|
||||||
<!-- Contributing -->
|
<!-- Contributing -->
|
||||||
## :wave: Contributing
|
## :wave: Contributing
|
||||||
|
|
||||||
Contributions are welcomed and encouraged. Please help to make this project even better!
|
Contributions are welcomed and encouraged. Please help to make this project even better! Refer to the [contribution page](CONTRIBUTING.md).
|
||||||
Refer to the [contribution page](CONTRIBUTING.md).
|
|
||||||
|
|
||||||
<!-- Translation -->
|
<!-- Translation -->
|
||||||
## :scroll: Translation
|
## :scroll: Translation
|
||||||
|
|
||||||
Native language translation of the InvenTree web application is [community contributed via crowdin](https://crowdin.com/project/inventree). **Contributions are welcomed and encouraged**.
|
Native language translation of the InvenTree web application is [community contributed via crowdin](https://crowdin.com/project/inventree). **Contributions are welcomed and encouraged**.
|
||||||
|
|
||||||
To contribute to the translation effort, navigate to the [InvenTree crowdin project](https://crowdin.com/project/inventree), create a free account, and start making translations suggestions for your language of choice!
|
|
||||||
|
|
||||||
<!-- Sponsor -->
|
<!-- Sponsor -->
|
||||||
## :money_with_wings: Sponsor
|
## :money_with_wings: Sponsor
|
||||||
|
|
||||||
If you use InvenTree and find it to be useful, please consider making a donation toward its continued development.
|
If you use InvenTree and find it to be useful, please consider [sponsoring the project](https://github.com/sponsors/inventree).
|
||||||
|
|
||||||
[Donate via PayPal](https://paypal.me/inventree?locale.x=en_AU)
|
|
||||||
|
|
||||||
<!-- Acknowledgments -->
|
<!-- Acknowledgments -->
|
||||||
## :gem: Acknowledgements
|
## :gem: Acknowledgements
|
||||||
|
Loading…
Reference in New Issue
Block a user