Prepare documentation for v1 release

[coderpatros]

The documentation needs a review before an official v1 release.

Current TODO:

• [ ] basic example usage for each command
• [ ] more docker image usage examples
• [ ] expand documentation for installing runtime dependencies for Ubuntu
• [ ] add documentation for installing runtime dependencies for Mac

Feel free to comment below if you think anything else is missing or needs improvement.

[coobr01]

@coderpatros Any updates on getting some docs around the Docker usage? I'd liked to use a local BOM file as input but it always gives me System.Byte[] if i don't specify an --output-file

[coderpatros]

What command and parameters are you using @coobr01?

[coobr01]

@coderpatros the one that ended up working was

docker run --rm -v "%cd%:/tmp" cyclonedx/cyclonedx-cli convert --input-file /tmp/bom-nodejs.xml --output-format CSV --output-file /tmp/coobr01.csv

If I remove the output-file param and just look to receive console output I get the System.Byte[] as a return.

[dmuse89]

@coderpatros, any update on this ticket?

I have spent several hours trying to get the latest binary to run on both mac and linux, but the setup documentation is missing. This is a bit frustrating, IMO, as there is no basic "Getting Started" section, nor a script to do whatever is necessary with the binaries to set up this tool.

You would probably have a higher adoption rate if a "Getting Started" section which describes how to set up the tool from was added.

[coderpatros]

@dmuse89 you should be able to just download the binary for your platform, mark the file as executable, and run it. You might have issues on Mac as we don't currently sign the binary with an Apple developer certificate. In that case it might be easier to use the Docker image.