From c96771ec026a786f748f2fcc3daf9458a512c035 Mon Sep 17 00:00:00 2001 From: Greg Back Date: Mon, 13 Feb 2017 10:12:12 -0600 Subject: [PATCH] Convert README to markdown; reorganize README content. --- README.md | 121 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 70 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 6722434..7a24035 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,89 @@ -
-

README

+# cti-python-stix2 -
-

OASIS Open Repository: cti-python-stix2

+*This is an [OASIS Open Repository](https://www.oasis-open.org/resources/open-repositories/). See the [Governance](#governance) section for more information.* -

This GitHub public repository ( https://github.com/oasis-open/cti-python-stix2 ) was created at the request of the OASIS Cyber Threat Intelligence (CTI) TC as an OASIS Open Repository to support development of open source resources related to Technical Committee work.

- -

While this Open Repository remains associated with the sponsor TC, its development priorities, leadership, intellectual property terms, participation rules, and other matters of governance are separate and distinct from the OASIS TC Process and related policies.

- -

All contributions made to this Open Repository are subject to open source license terms expressed in the BSD-3-Clause License. That license was selected as the declared "Applicable License" when the Open Repository was created.

- -

As documented in "Public Participation Invited", contributions to this OASIS Open Repository are invited from all parties, whether affiliated with OASIS or not. Participants must have a GitHub account, but no fees or OASIS membership obligations are required. Participation is expected to be consistent with the OASIS Open Repository Guidelines and Procedures, the open source LICENSE designated for this particular repository, and the requirement for an Individual Contributor License Agreement that governs intellectual property.

- -
- -
-

Statement of Purpose

- -

Statement of Purpose for this OASIS Open Repository (cti-python-stix2) as proposed and approved [bis] by the TC:

- -

The purpose of this GitHub repository (Python library for STIX 2) is to provide APIs for serializing and de-serializing STIX 2 JSON content, along with higher-level APIs for common tasks, including data markings, versioning, and for resolving STIX IDs across multiple data sources.

+This repository provides Python APIs for serializing and de-serializing STIX 2 JSON content, along with higher-level APIs for common tasks, including data markings, versioning, and for resolving STIX IDs across multiple data sources. -
+## Governance -

Additions to Statement of Purpose

+This GitHub public repository ( +**** ) was [proposed](https://lists.oasis-open.org/archives/cti/201702/msg00008.html) +and +[approved](https://www.oasis-open.org/committees/download.php/60009/) +\[[bis](https://issues.oasis-open.org/browse/TCADMIN-2549)\] by the [OASIS Cyber Threat Intelligence (CTI) +TC](https://www.oasis-open.org/committees/cti/) as an [OASIS Open +Repository](https://www.oasis-open.org/resources/open-repositories/) to +support development of open source resources related to Technical +Committee work. -

Repository Maintainers may include here any clarifications — any additional sections, subsections, and paragraphs that the Maintainer(s) wish to add as descriptive text, reflecting (sub-) project status, milestones, releases, modifications to statement of purpose, etc. The project Maintainers will create and maintain this content on behalf of the participants.

-
+While this Open Repository remains associated with the sponsor TC, its +development priorities, leadership, intellectual property terms, +participation rules, and other matters of governance are [separate and +distinct](https://github.com/oasis-open/cti-python-stix2/blob/master/CONTRIBUTING.md#governance-distinct-from-oasis-tc-process) +from the OASIS TC Process and related policies. -
-

Maintainers

+All contributions made to this Open Repository are subject to open +source license terms expressed in the [BSD-3-Clause +License](https://www.oasis-open.org/sites/www.oasis-open.org/files/BSD-3-Clause.txt). +That license was selected as the declared ["Applicable +License"](https://www.oasis-open.org/resources/open-repositories/licenses) +when the Open Repository was created. -

Open Repository Maintainers are responsible for oversight of this project's community development activities, including evaluation of GitHub pull requests and preserving open source principles of openness and fairness. Maintainers are recognized and trusted experts who serve to implement community goals and consensus design preferences.

+As documented in ["Public Participation +Invited](https://github.com/oasis-open/cti-python-stix2/blob/master/CONTRIBUTING.md#public-participation-invited)", +contributions to this OASIS Open Repository are invited from all +parties, whether affiliated with OASIS or not. Participants must have a +GitHub account, but no fees or OASIS membership obligations are +required. Participation is expected to be consistent with the [OASIS +Open Repository Guidelines and +Procedures](https://www.oasis-open.org/policies-guidelines/open-repositories), +the open source +[LICENSE](https://github.com/oasis-open/cti-python-stix2/blob/master/LICENSE) +designated for this particular repository, and the requirement for an +[Individual Contributor License +Agreement](https://www.oasis-open.org/resources/open-repositories/cla/individual-cla) +that governs intellectual property. -

Initially, the associated TC members have designated one or more persons to serve as Maintainer(s); subsequently, participating community members may select additional or substitute Maintainers, per consensus agreements.

-

Current Maintainers of this Open Repository

+### Maintainers -
    - +Open Repository +[Maintainers](https://www.oasis-open.org/resources/open-repositories/maintainers-guide) +are responsible for oversight of this project's community development +activities, including evaluation of GitHub [pull +requests](https://github.com/oasis-open/cti-python-stix2/blob/master/CONTRIBUTING.md#fork-and-pull-collaboration-model) +and +[preserving](https://www.oasis-open.org/policies-guidelines/open-repositories#repositoryManagement) +open source principles of openness and fairness. Maintainers are +recognized and trusted experts who serve to implement community goals +and consensus design preferences. -
  • Greg Back; GitHub ID: https://github.com/gtback/; WWW: MITRE Corporation
    • -
  • Chris Lenk; GitHub ID: https://github.com/clenk/; WWW: MITRE Corporation
    • +Initially, the associated TC members have designated one or more persons +to serve as Maintainer(s); subsequently, participating community members +may select additional or substitute Maintainers, per [consensus +agreements](https://www.oasis-open.org/resources/open-repositories/maintainers-guide#additionalMaintainers). - -
+**Current Maintainers of this Open Repository** -
+* [Greg Back](mailto:gback@mitre.org); GitHub ID: ; WWW: [MITRE Corporation](http://www.mitre.org/) +* [Chris Lenk](mailto:clenk@mitre.org); GitHub ID: ; WWW: [MITRE Corporation](http://www.mitre.org/) -

About OASIS Open Repositories

+## About OASIS Open Repositories -

+* [Open Repositories: Overview and Resources](https://www.oasis-open.org/resources/open-repositories/) +* [Frequently Asked Questions](https://www.oasis-open.org/resources/open-repositories/faq) +* [Open Source Licenses](https://www.oasis-open.org/resources/open-repositories/licenses) +* [Contributor License Agreements (CLAs)](https://www.oasis-open.org/resources/open-repositories/cla) +* [Maintainers' Guidelines and Agreement](https://www.oasis-open.org/resources/open-repositories/maintainers-guide) -
-

Feedback

- -

Questions or comments about this Open Repository's activities should be composed as GitHub issues or comments. If use of an issue/comment is not possible or appropriate, questions may be directed by email to the Maintainer(s) listed above. Please send general questions about Open Repository participation to OASIS Staff at repository-admin@oasis-open.org and any specific CLA-related questions to repository-cla@oasis-open.org.

- -
+## Feedback +Questions or comments about this Open Repository's activities should be +composed as GitHub issues or comments. If use of an issue/comment is not +possible or appropriate, questions may be directed by email to the +Maintainer(s) [listed above](#currentMaintainers). Please send general +questions about Open Repository participation to OASIS Staff at + and any specific CLA-related questions +to .