Skip to content

Commit

Permalink
Updated README and template
Browse files Browse the repository at this point in the history
  • Loading branch information
joachimmetz committed Apr 4, 2021
1 parent c908466 commit 6f340d4
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,22 @@
This project provides [documentation](https://artifacts-kb.readthedocs.io/en/latest)
accompanying [Digital Forensics Artifact Repository](https://github.com/ForensicArtifacts/artifacts).

### Contributing

If you want to contribute a description of an artifact definition please use
the [Template](https://github.com/ForensicArtifacts/artifacts-kb/blob/master/Template.md).

## Contact
Create new descriptions under the most specific topic subdirectory under
docs/sources, and update the corresponding index.rst file.

Please do not mention tools that can be used to extract information from the
artifact. The goal of the Digital Forensics Artifact Knowledge Base is to
describe artifacts, not to provide yet another repository of tools.

Make sure that URLs of referenced sources can be resolved, dead links will
be updated or removed.

### Contact

* [[email protected]](https://groups.google.com/forum/#!forum/forensicartifacts)
* Artifacts channel of [Open Source DFIR Slack](https://github.com/open-source-dfir/slack)
Expand Down
4 changes: 2 additions & 2 deletions Template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This section provides a short description of the artifact.

## Significance
### Significance

Section that explains the significance of the artficate, for example it
is known to be used as a persistence mechanism or provides insight into user
Expand All @@ -14,7 +14,7 @@ Sub section that explains a specific detail of the artifact.

Please do not mention tools that can be used to extract information from the
artifact. The goal of the Digital Forensics Artifact Knowledge Base is to
describe artifacts not to provide yet another repository of tools.
describe artifacts, not to provide yet another repository of tools.

### References

Expand Down

0 comments on commit 6f340d4

Please sign in to comment.