Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@tiffb @mikecarenzo
tiffb authored and mikecarenzo committed Feb 27, 2024
1 parent 0ca0e75 commit a0bb893
Showing 1 changed file with 22 additions and 65 deletions.
87 changes: 22 additions & 65 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,87 +1,44 @@
# Mappings Editor

<!-- TODO Put a one paragraph summary of the project here. -->

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure
dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt
mollit anim id est laborum.
The Mappings Editor is a custom-built tool developed under the Mappings Explorer project.
This lightweight, easy to use tool is being used internally by the [Center for Threat Informed Defense](https://mitre-engenuity.org/cybersecurity/center-for-threat-informed-defense/)
to create new and update existing capability mappings to [MITRE ATT&CK®](https://attack.mitre.org/) objects.
It is available for your own use as a public beta, but most Mappings Explorer users should
not need to use this tool. Instead, you should generally use the mappings data available on
the Mappings Explorer website.

**Table Of Contents:**

<!--
TODO The table of contents should include only h2-h6, NOT h1. The "Markdown All In One"
extension for VS Code will update the TOC automatically for you:
https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
Set the extension's TOC:Levels setting to "2..6"
-->

- [Getting Started](#getting-started)
- [Getting Involved](#getting-involved)
- [Questions and Feedback](#questions-and-feedback)
- [How Do I Contribute?](#how-do-i-contribute)
- [Notice](#notice)

## Getting Started

<!-- TODO Write one paragraph about how users should get started,
and update the table of resources below. -->

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure
dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt
mollit anim id est laborum.

| Resource | Description |
| --------------- | ------------------------ |
| [Resource 1](#) | Description of resource. |
| [Resource 2](#) | Description of resource. |
| [Resource 3](#) | Description of resource. |

## Getting Involved

<!-- TODO Add some bullets telling users how to get involved. -->

There are several ways that you can get involved with this project and help
advance threat-informed defense:

- **Way to get involved 1.** Lorem ipsum dolor sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
- **Way to get involved 2.** Ut enim ad minim veniam, quis nostrud exercitation ullamco
laboris nisi ut aliquip ex ea commodo consequat.
- **Way to get involved 3.** Duis aute irure dolor in reprehenderit in voluptate velit
esse cillum dolore eu fugiat nulla pariatur.

## Questions and Feedback

Please submit issues for any technical questions/concerns or contact
[ctid@mitre-engenuity.org](mailto:ctid@mitre-engenuity.org?subject=Question%20about%20mappings-editor)
directly for more general inquiries.

Also see the guidance for contributors if are you interested in contributing or simply
reporting issues.
To get started, visit the project website.

| Resource | Description |
| -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| [Mappings Editor](https://center-for-threat-informed-defense.github.io/mappings-editor)) | An interactive, web-based tool for creating your own mappings. (This tool is available as a public beta.) |
| [Mappings Explorer](https://center-for-threat-informed-defense.github.io/mappings-explorer/) | A website to access, explore, search, and download our ATT&CK mappings. |

## How Do I Contribute?

We welcome your feedback and contributions to help advance
Mappings Editor. Please see the guidance for contributors if are you
interested in [contributing or simply reporting issues.](/CONTRIBUTING.md)
We welcome your feedback and contributions to help advance Mappings Editor. Please see
the guidance for contributors if are you interested in [contributing.](/CONTRIBUTING.md)

The Mappings Editor is released as a public beta; you may try using it to create your own
mappings data. The mappings data can be used internally inside your organization, or if you
think the public would benefit, we would be happy to accept pull requests for new mappings.
Please [get in touch with us]((mailto:ctid@mitre-engenuity.org?subject=Mappings%20Explorer%20framework%20submission)) ahead of time so that we can coordinate submissions.

Please submit
[issues](https://github.com/center-for-threat-informed-defense/mappings-editor/issues) for
any technical questions/concerns or contact
[ctid@mitre-engenuity.org](mailto:ctid@mitre-engenuity.org?subject=subject=Question%20about%20mappings-editor)
Please submit [issues](https://github.com/center-for-threat-informed-defense/mappings-editor/issues) for
any technical questions/concerns or contact [ctid@mitre-engenuity.org](mailto:ctid@mitre-engenuity.org?subject=subject=Question%20about%20mappings-editor)
directly for more general inquiries.

## Notice

<!-- TODO Add PRS prior to publication. -->

Copyright 2023 MITRE Engenuity. Approved for public release. Document number REPLACE_WITH_PRS_NUMBER
Copyright 2023 MITRE Engenuity. Approved for public release. Document number CT0104

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
file except in compliance with the License. You may obtain a copy of the License at
Expand Down

0 comments on commit a0bb893

Please sign in to comment.