added docs and makefile

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Upcoming changes...
+
+
+## [0.0.1] - 2023-06-??
+### Added
+- ?
+
+[0.0.1]: https://github.com/scanoss/scanoss.java/compare/v0.0.0...v0.0.1

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+Thank you for considering contributing to SCANOSS. It's people like you that make SCANOSS such a great tool. Feel welcome and read the following sections
+in order to know how to get involved, ask questions and more importantly how to work on something.
+
+SCANOSS is an open source project, and we love to receive contributions from our community. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code.
+A welcome addition to the project is an integration with a new source code repository.
+
+### Submitting bugs
+
+If you are submitting a bug, please tell us:
+
+- Version of SCANOSS you are using
+- Version of Python, Go, Java, etc. you are using
+- how to reproduce the bug.
+
+### Pull requests
+
+Want to submit a pull request? Great! But please follow some basic rules:
+
+- Write a brief description that help us understand what you are trying to accomplish: what the change does, link to any relevant issue
+- If you are changing a source file please make sure that you only include in the changeset the lines changed by you (beware of your editor reformatting the file)
+- If you are adding functionality, please write a unit test.
+
+### Licensing
+
+The SCANOSS Platform is released under the GPL-2.0 license. If you wish to contribute, you must accept that you are aware of the license under which the project is released, and that your contribution will be released under the same license.
+Sometimes the GPL-2.0 license is incompatible with other licenses chosen by other projects. Therefore, you must accept that your contribution can also be released under the MIT license, which is the license we choose for those situations.
+Unless you expressly request otherwise, we may use your name, email address, username or URL for your attribution notice text. The submission of your contribution implies that you agree with these licensing terms.

Makefile

@@ -0,0 +1,14 @@
+
+# HELP
+# This will output the help for each task
+# thanks to https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+.PHONY: help
+
+help: ## This help
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+.DEFAULT_GOAL := help
+
+test:  ## Run package tests
+	@echo "Running package tests..."
+	mvn test

README.md

@@ -0,0 +1,48 @@
+# SCANOSS Java Library
+The SCANOSS java package provides a simple, easy to consume library for interacting with SCANOSS APIs/Engine.
+
+
+## Usage
+TBD
+
+Include in a maven project using:
+```xml
+        <dependency>
+            <groupId>com.scanoss</groupId>
+            <artifactId>scanoss</artifactId>
+            <version>0.1.0</version>
+        </dependency>
+```
+
+## Development
+Before starting with development of this project, please read our [CONTRIBUTING](CONTRIBUTING.md) and [CODE OF CONDUCT](CODE_OF_CONDUCT.md).
+
+### Requirements
+Java 11 or higher.
+
+The dependencies can be found in the [pom.xml](pom.xml).
+
+### Package Development
+
+#### Versioning
+The version of the package is defined in the [pom.xml](pom.xml) file. Please update this version before packaging/releasing an update.
+
+#### Packaging
+To package the library, please run:
+```bash
+make dist
+```
+
+#### Deployment
+
+Then deploy to prod:
+```bash
+make publish
+```
+This will deploy the package to [Maven Central](https://maven.org/?).
+
+## Bugs/Features
+To request features or alert about bugs, please do so [here](https://github.com/scanoss/scanoss.java/issues).
+
+## Changelog
+Details of major changes to the library can be found in [CHANGELOG.md](CHANGELOG.md).