From f4f5eb697faf2449705f2dade393be7ce398593c Mon Sep 17 00:00:00 2001 From: Steven Pritchard Date: Tue, 3 Dec 2024 13:25:50 -0600 Subject: [PATCH] Update README and other documentation Fixes #3 --- CHANGELOG.md | 7 ++----- README.md | 6 ++---- TODO.md | 12 ------------ compliance_engine.gemspec | 4 +--- 4 files changed, 5 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e2e70e4..0d60924 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,2 @@ -## [Unreleased] - -## [0.1.0] - 2023-10-16 - -- Initial release +### 0.1.0 / 2024-12-03 +* Initial release diff --git a/README.md b/README.md index 49a9916..092ec51 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. diff --git a/TODO.md b/TODO.md index 7654bf0..7312db6 100644 --- a/TODO.md +++ b/TODO.md @@ -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 diff --git a/compliance_engine.gemspec b/compliance_engine.gemspec index 8a621e8..ad07d81 100644 --- a/compliance_engine.gemspec +++ b/compliance_engine.gemspec @@ -9,11 +9,9 @@ Gem::Specification.new do |spec| spec.email = ['steve@sicura.us'] 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."