Skip to content

Commit

Permalink
Updating README.md and INSTALL files
Browse files Browse the repository at this point in the history
  • Loading branch information
MaKyOtOx committed Jul 2, 2018
1 parent e0a873f commit d40b0bd
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
2 changes: 1 addition & 1 deletion INSTALL
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See (Installation guide)[https://github.com/Patrowl/PatrowlDocs/blob/master/installation/installation-guide.md]
See [Installation guide](https://github.com/Patrowl/PatrowlDocs/blob/master/installation/installation-guide.md)
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
![](https://github.com/Patrowl/PatrowlDocs/blob/master/images/logos/logo-patrowl-light.png)

[![Join the chat at https://gitter.im/Patrowl/Support](https://badges.gitter.im/Patrowl/Support.png)](https://gitter.im/Patrowl/Support)

# **PatrOwl**
[PatrOwl](https://www.patrowl.io/) is a scalable, free and open-source solution for orchestrating Security Operations.

**PatrowlEngines** is the engine framework and the supported list of engines performing the operations (scans, searches, API calls, ...) on due time. The engines are managed by one or several instance of [PatrowlManager](https://github.com/Patrowl/PatrowlManager/).

# Architecture
![Technical Overview](https://github.com/Patrowl/PatrowlDocs/blob/master/images/userguide/technical-overview.png)

# Installation and deployment
See the [Installation guide](https://github.com/Patrowl/PatrowlDocs/blob/master/installation/installation-guide.md)

# Usage
See the [User guide](https://github.com/Patrowl/PatrowlDocs/blob/master/installation/user-guide.md)

# License
PatrOwl is an open source and free software released under the [AGPL](https://github.com/Patrowl/PatrowlDocs/blob/master/LICENSE) (Affero General Public License). We are committed to ensure that PatrOwl will remain a free and open source project on the long-run.

# Updates
Information, news and updates are regularly posted on [Patrowl.io Twitter account](https://twitter.com/patrowl_io) and on [the blog](https://blog.patrowl.io/).

# Contributing
Please see our [Code of conduct](https://github.com/Patrowl/PatrowlDocs/blob/master/docs/support/code_of_conduct.md). We welcome your contributions. Please feel free to fork the code, play with it, make some patches and send us pull requests via [issues](https://github.com/Patrowl/PatrowlManager/issues).

# Support
Please [open an issue on GitHub](https://github.com/Patrowl/PatrowlManager/issues) if you'd like to report a bug or request a feature. We are also available on [Gitter](https://gitter.im/Patrowl/Support) to help you out.

If you need to contact the project team, send an email to <[email protected]>.

# Copyright
Copyright (C) 2018 Nicolas MATTIOCCO ([@MaKyOtOx](https://twitter.com/MaKyOtOx) - [email protected])

0 comments on commit d40b0bd

Please sign in to comment.