diff --git a/README.md b/README.md index bb4728e2..4d763b55 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Given a readme file (or a GitHub repository) SOMEF will extract the following ca - **Usage examples**: Assumptions and considerations recorded by the authors when executing a software component, or examples on how to use it. - **Documentation**: Where to find additional documentation about a software component. - **Requirements**: Pre-requisites and dependencies needed to execute a software component. -- **Contributors**: Contirbutors to a software component +- **Contributors**: Contributors to a software component - **FAQ**: Frequently asked questions about a software component - **Support**: Guidelines and links of where to obtain support for a software component - **License**: License and usage terms of a software component @@ -33,6 +33,7 @@ Given a readme file (or a GitHub repository) SOMEF will extract the following ca - **Changelog**: Description of the changes between versions - **Issue tracker**: Link where to open issues for the target repository - **Programming languages**: Languages used in the repository +- **Acknowledgements**: People or institutions that the authors would like to acknowledge in their software component We use different supervised classifiers, header analysis, regular expressions and the GitHub API to retrieve all these fields (more than one technique may be used for each field) diff --git a/docs/index.md b/docs/index.md index f2c23f04..96d679b6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,7 +22,7 @@ Given a readme file (or a GitHub repository) SOMEF will extract the following ca - **Usage examples**: Assumptions and considerations recorded by the authors when executing a software component, or examples on how to use it. - **Documentation**: Where to find additional documentation about a software component. - **Requirements**: Pre-requisites and dependencies needed to execute a software component. -- **Contributors**: Contirbutors to a software component +- **Contributors**: Contributors to a software component - **FAQ**: Frequently asked questions about a software component - **Support**: Guidelines and links of where to obtain support for a software component - **License**: License and usage terms of a software component @@ -39,6 +39,7 @@ Given a readme file (or a GitHub repository) SOMEF will extract the following ca - **Changelog**: Description of the changes between versions - **Issue tracker**: Link where to open issues for the target repository - **Programming languages**: Languages used in the repository +- **Acknowledgements**: People or institutions that the authors would like to acknowledge in their software component SOMEF uses the [Software Description Ontology](https://w3id.org/okn/o/sd), which extends [Schema.org](https://schema.org) and [Codemeta](https://codemeta.github.io/terms/) to represent all the categories listed above. To see different export options please see [the getting started page](https://somef.readthedocs.io/en/latest/usage/). diff --git a/src/somef/__init__.py b/src/somef/__init__.py index d5d32c48..956e83da 100644 --- a/src/somef/__init__.py +++ b/src/somef/__init__.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- -__version__ = "0.3.1" +__version__ = "0.5.0"