Skip to content

Commit

Permalink
Update README and other documentation
Browse files Browse the repository at this point in the history
Fixes #3
  • Loading branch information
silug committed Dec 3, 2024
1 parent a4f3134 commit f4f5eb6
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 24 deletions.
7 changes: 2 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,2 @@
## [Unreleased]

## [0.1.0] - 2023-10-16

- Initial release
### 0.1.0 / 2024-12-03
* Initial release
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# ComplianceEngine

TODO: Delete this and the text below, and describe your gem

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/compliance_engine`. To experiment with that code, run `bin/console` for an interactive prompt.
Work with the [Sicura](https://sicura.us/) (formerly [SIMP](https://simp-project.com/)) Compliance Engine data.

## Installation

Expand All @@ -28,4 +26,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/compliance_engine.
Bug reports and pull requests are welcome on GitHub at https://github.com/simp/rubygem-simp-compliance_engine.
12 changes: 0 additions & 12 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,7 @@
Unimplemented features, in no particular order:

- [x] Limit ces/checks/controls based on selected profile
- [x] Correlation between ces/controls and checks
- [ ] Test merge of profiles (ordering of settings)
- [ ] Test malformed data
- [ ] Storage and resolution of facts
- [ ] Confinement
- [ ] Enforcement tolerance
- [ ] Hiera backend functionality
- [ ] Add missing documentation
- [ ] Reset state when files are updated
- [ ] Shared state between multiple objects (store file data)
- [ ] Command-line tools for examining compliance data
- [ ] Lint support (replace `scelint`)
- [ ] Resolve oval ids to CEs
- [ ] Puppet environment support
- [ ] Read/store metadata
- [ ] Load compliance data from a module path
4 changes: 1 addition & 3 deletions compliance_engine.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@ Gem::Specification.new do |spec|
spec.email = ['[email protected]']

spec.summary = 'Parser for Sicura Compliance Engine data'
spec.homepage = 'https://sicura.us/'
spec.homepage = 'https://simp-project.com/docs/sce/'
spec.required_ruby_version = '>= 2.7.0'

# spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"

spec.metadata['homepage_uri'] = spec.homepage
spec.metadata['source_code_uri'] = 'https://github.com/simp/rubygem-simp-compliance_engine'
# spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
Expand Down

0 comments on commit f4f5eb6

Please sign in to comment.