Skip to content

Commit

Permalink
Adjusted README and related files extension
Browse files Browse the repository at this point in the history
  • Loading branch information
brnquester committed Dec 28, 2021
1 parent d05cd81 commit 97b5a52
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 29 deletions.
2 changes: 1 addition & 1 deletion AUTHORS → AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Development Lead
Contributors
------------

None yet. Why not be the first?
Looking for engaged developers to make IntegrityGuard an awesome tool.
5 changes: 5 additions & 0 deletions HISTORY → HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
History
=======

0.1.1 (2021-12-28)
------------------

* Adjusted README file.

0.1.0 (2021-12-28)
------------------

Expand Down
6 changes: 3 additions & 3 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
include AUTHORS
include HISTORY
include AUTHORS.rst
include HISTORY.rst
include LICENSE
include README
include README.rst

recursive-include tests *
recursive-exclude * __pycache__
Expand Down
21 changes: 0 additions & 21 deletions README

This file was deleted.

36 changes: 36 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
==============
IntegrityGuard
==============

.. image:: https://img.shields.io/pypi/v/integrityguard.svg
:target: https://pypi.python.org/pypi/integrityguard

.. image:: https://pyup.io/repos/github/bruno-canada/integrityguard/shield.svg
:target: https://pyup.io/repos/github/bruno-canada/integrityguard/
:alt: Updates

.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
:target: code_of_conduct.md
:alt: Contributor Covenant

Multiplatform agent for file integrity monitoring (FIM).

The main motivation for this project is to offer all the minimum features required for a reliable FIM that is independent of any other big monitoring platform.

**IMPORTANT**: This project is currently an ALPHA release. Not suitable for production environment, it is still a work in progress.

Features highlight
--------------------

* Simple and centralized configuration YAML file (``config.yml``)
* Generate logs of any changes in real-time for future auditing
* Push notifications to an API endpoint
* Send email alerts
* Supported hashing methods: "md5", "sha1", "sha224", "sha256", "sha384", "sha512"

Call for contributors
----------------------

This project is just at the begining of its development. We're currently looking for engaged and energized people to colaborate and make it awesome.


8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

from setuptools import setup, find_packages

with open('README') as readme_file:
with open('README.md') as readme_file:
readme = readme_file.read()

with open('HISTORY') as history_file:
with open('HISTORY.md') as history_file:
history = history_file.read()

requirements = ['Click>=7.0', ]
Expand All @@ -16,7 +16,7 @@

setup(
author="Bruno Bueno",
author_email='bbueno_python@fastmail.com',
author_email='integrityguard@fastmail.com',
python_requires='>=3.6',
classifiers=[
'Development Status :: 2 - Pre-Alpha',
Expand Down Expand Up @@ -44,6 +44,6 @@
test_suite='tests',
tests_require=test_requirements,
url='https://github.com/bruno-canada/integrityguard',
version='0.1.0',
version='0.1.1',
zip_safe=False,
)

0 comments on commit 97b5a52

Please sign in to comment.