Skip to content

Commit

Permalink
Reduce readme (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
cugu committed May 1, 2020
1 parent 0390ed4 commit b2a0f66
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 35 deletions.
18 changes: 0 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,6 @@
The artifactlib project provides a Go package for processing
forensic artifact definition files.

## Artifact definition files
The artifact definition format is described in detail in the Style Guide
([https://github.com/forensicanalysis/artifacts/blob/master/style_guide.md](https://github.com/forensicanalysis/artifacts/blob/master/style_guide.md)).
The following shows an example for an artifact definition file. It defines the
location of linux audit log files on a system.

```
name: LinuxAuditLogFiles
doc: Linux audit log files.
sources:
- type: FILE
attributes: {paths: ['/var/log/audit/*']}
supported_os: [Linux]
```

We use [https://github.com/forensicanalysis/artifacts](https://github.com/forensicanalysis/artifacts) as the main repository for
forensic artifacts definitions.



### Installation
Expand Down
17 changes: 0 additions & 17 deletions doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,4 @@

// Package artifactlib provides a Go package for processing
// forensic artifact definition files.
//
// Artifact definition files
//
// The artifact definition format is described in detail in the Style Guide
// (https://github.com/forensicanalysis/artifacts/blob/master/style_guide.md).
// The following shows an example for an artifact definition file. It defines the
// location of linux audit log files on a system.
//
// name: LinuxAuditLogFiles
// doc: Linux audit log files.
// sources:
// - type: FILE
// attributes: {paths: ['/var/log/audit/*']}
// supported_os: [Linux]
//
// We use https://github.com/forensicanalysis/artifacts as the main repository for
// forensic artifacts definitions.
package artifactlib

0 comments on commit b2a0f66

Please sign in to comment.