-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/develop'
- Loading branch information
Showing
3 changed files
with
44 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
![snipe-it-by-grok](https://github.com/snipe/snipe-it/assets/197404/b515673b-c7c8-4d9a-80f5-9fa58829a602) | ||
|
||
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/snipe-it/localized.svg)](https://crowdin.com/project/snipe-it) [![Docker Pulls](https://img.shields.io/docker/pulls/snipe/snipe-it.svg)](https://hub.docker.com/r/snipe/snipe-it/) [![Twitter Follow](https://img.shields.io/twitter/follow/snipeitapp.svg?style=social)](https://twitter.com/snipeitapp) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/553ce52037fc43ea99149785afcfe641)](https://app.codacy.com/gh/snipe/snipe-it/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Tests](https://github.com/snipe/snipe-it/actions/workflows/tests.yml/badge.svg)](https://github.com/snipe/snipe-it/actions/workflows/tests.yml) | ||
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/snipe-it/localized.svg)](https://crowdin.com/project/snipe-it) [![Docker Pulls](https://img.shields.io/docker/pulls/snipe/snipe-it.svg)](https://hub.docker.com/r/snipe/snipe-it/) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/553ce52037fc43ea99149785afcfe641)](https://app.codacy.com/gh/snipe/snipe-it/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Tests](https://github.com/snipe/snipe-it/actions/workflows/tests.yml/badge.svg)](https://github.com/snipe/snipe-it/actions/workflows/tests.yml) | ||
[![All Contributors](https://img.shields.io/badge/all_contributors-331-orange.svg?style=flat-square)](#contributing) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/yZFtShAcKk) | ||
|
||
## Snipe-IT - Open Source Asset Management System | ||
|
@@ -14,6 +14,21 @@ Snipe-IT is actively developed and we [release quite frequently](https://github. | |
> [!TIP] | ||
> __This is web-based software__. This means there is no executable file (aka no .exe files), and it must be run on a web server and accessed through a web browser. It runs on any Mac OSX, any flavor of Linux, as well as Windows, and we have a [Docker image](https://snipe-it.readme.io/docs/docker) available if that's what you're into. | ||
----- | ||
|
||
### Table of Contents | ||
* [Installation](#installation) | ||
* [User's Manual](#user-s-manual) | ||
* [Bug Reports & Feature Requests](#bug-reports---feature-requests) | ||
* [Security](#security) | ||
* [Upgrading](#upgrading) | ||
* [Announcement List](#announcement-list) | ||
* [Translations!](#translations-) | ||
* [Libraries, Modules & Related Projects](#libraries--modules---related-projects) | ||
* [Join the Community!](#join-the-community-) | ||
* [Contributing](#contributing) | ||
|
||
|
||
----- | ||
|
||
### Installation | ||
|
@@ -22,8 +37,6 @@ For instructions on installing and configuring Snipe-IT on your server, check ou | |
|
||
If you're having trouble with the installation, please check the [Common Issues](https://snipe-it.readme.io/docs/common-issues) and [Getting Help](https://snipe-it.readme.io/docs/getting-help) documentation, and search this repository's open *and* closed issues for help. | ||
|
||
<!-- [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) --> | ||
|
||
----- | ||
### User's Manual | ||
For help using Snipe-IT, check out the [user's manual](https://snipe-it.readme.io/docs/overview). | ||
|
@@ -35,9 +48,16 @@ Feel free to check out the [GitHub Issues for this project](https://github.com/s | |
|
||
> [!IMPORTANT] | ||
> **PLEASE see the [Getting Help Guidelines](https://snipe-it.readme.io/docs/getting-help) and [Common Issues](https://snipe-it.readme.io/docs/common-issues) before opening a ticket, and be sure to complete all of the questions in the Github Issue template to help us to help you as quickly as possible.** | ||
> | ||
----- | ||
|
||
### Security | ||
|
||
> [!IMPORTANT] | ||
> **To report a security vulnerability, please email [email protected] instead of using the issue tracker.** | ||
----- | ||
|
||
|
||
### Upgrading | ||
|
||
Please see the [upgrading documentation](https://snipe-it.readme.io/docs/upgrading) for instructions on upgrading Snipe-IT. | ||
|
@@ -82,23 +102,26 @@ Since the release of the JSON REST API, several third-party developers have been | |
|
||
----- | ||
|
||
### Contributing | ||
### Join the Community! | ||
|
||
Please refrain from submitting issues or pull requests generated by fully-automated tools. Maintainers reserve the right, at their sole discretion, to close such submissions and to block any account responsible for them. | ||
- **[Join our Discord](https://discord.gg/yZFtShAcKk)!** It’s full of great people. We even wrote about it [here](https://grokstar.dev/culture/2024/06/the-unlikely-rise-of-discord-as-a-support-channel/)! | ||
- **Follow us on Bluesky** at [@snipeitapp.com](https://bsky.app/profile/snipeitapp.com) | ||
- **Follow us on Mastodon** at [hachyderm.io/@grokability](https://hachyderm.io/@grokability) | ||
- **Follow our blog** at [Grokstar.Dev](https://grokstar.dev) | ||
- **Subscribe here** on Github for notifications about new releases. (We recommend selecting "Releases" only for mosrt users - this repo can get noisy.) | ||
|
||
Ideally, contributions should follow from a human-to-human discussion in the form of an issue. | ||
----- | ||
|
||
Please see the complete documentation on [contributing and developing for Snipe-IT](https://snipe-it.readme.io/docs/contributing-overview). | ||
### Contributing | ||
|
||
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | ||
**Please refrain from submitting issues or pull requests generated by fully-automated tools. Maintainers reserve the right, at their sole discretion, to close such submissions and to block any account responsible for them.** | ||
|
||
The ERD is available [online here](https://drawsql.app/templates/snipe-it). | ||
Contributions should follow from a human-to-human discussion in the form of an issue for the best chances of being merged into the core project. (Sometimes we might already be working on that feature, sometimes we've decided against ) | ||
|
||
[Here is a list](CONTRIBUTORS.md) of the wonderful people that have contributed to the Snipe-IT. | ||
Please see the complete documentation on [contributing and developing for Snipe-IT](https://snipe-it.readme.io/docs/contributing-overview). | ||
|
||
----- | ||
This project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | ||
|
||
### Security | ||
The ERD is available [online here](https://drawsql.app/templates/snipe-it). | ||
|
||
> [!IMPORTANT] | ||
> **To report a security vulnerability, please email [email protected] instead of using the issue tracker.** | ||
Be sure to check out all of the [amazing people](CONTRIBUTORS.md) that have contributed to Snipe-IT over the years! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters