Skip to content

Commit 807bde2

Browse files
committed
feat: have CycloneDX SBOM
1 parent 8c952ba commit 807bde2

File tree

2 files changed

+1130
-9
lines changed

2 files changed

+1130
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
This is a .NET implementation of the REST API of FOSSology.
44

55
## Project Build Status
6+
67
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
78
[![Build status](https://ci.appveyor.com/api/projects/status/has0mtn545n0nods?svg=true)](https://ci.appveyor.com/project/tngraf/fossology-rest-dotnet)
89
[![NuGet](https://img.shields.io/badge/nuget-v1.4.0-blue.svg)](https://www.nuget.org/packages/Fossology.Rest.Dotnet/)
@@ -13,6 +14,7 @@ copyrights and other keywords within the given source code.
1314
More information about FOSSology can be found [here](https://www.fossology.org/.)
1415

1516
## Library
17+
1618
* **Fossology.Rest.Dotnet** - The REST API implementation.
1719
* **Fossology.Rest.Dotnet.Model** - The object model.
1820
* **Fossology.Rest.Dotnet.Test** - Unit tests.
@@ -23,11 +25,10 @@ More information about FOSSology can be found [here](https://www.fossology.org/.
2325

2426
## Documentation on the FOSSology REST API
2527

26-
* Read https://www.fossology.org/get-started/basic-rest-api-calls/
27-
and https://github.com/fossology/fossology/wiki/FOSSology-REST-API
28-
* Open Swagger editor at http://editor.swagger.io/
29-
* Load FOSSology API description from
30-
https://raw.githubusercontent.com/fossology/fossology/master/src/www/ui/api/documentation/openapi.yaml
28+
* Read <https://www.fossology.org/get-started/basic-rest-api-calls/>
29+
and <https://github.com/fossology/fossology/wiki/FOSSology-REST-API>
30+
* Open Swagger editor at <http://editor.swagger.io/>
31+
* Load FOSSology API description from <https://raw.githubusercontent.com/fossology/fossology/master/src/www/ui/api/documentation/openapi.yaml>
3132
* Modify in the editor the server URL so match your instance
3233
* Use the access token generated by FOSSology to authorize
3334
Swagger to access your FOSSology instance.
@@ -36,16 +37,16 @@ More information about FOSSology can be found [here](https://www.fossology.org/.
3637

3738
* Install Docker for Windows
3839
* Switch to Linux Containers
39-
* Open a PowerShell window and run
40+
* Open a PowerShell window and run
4041
```docker pull fossology/fossology```
4142
* Start FOSSology via the command
4243
```docker run -p 8081:80 fossology/fossology```
43-
* Open the following URL in a browser:
44-
http://localhost:8081/repo/
44+
* Open the following URL in a browser:
45+
<http://localhost:8081/repo/>
4546
* Login via the admin account
4647
user = ```fossy```, pwd = ```fossy```
4748
* Start the demo application and create a token
48-
* Optionally create a folder and upload a package
49+
* Optionally create a folder and upload a package
4950

5051
## License
5152

@@ -59,3 +60,7 @@ You may obtain a copy of the License at
5960

6061
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
6162
See the License for the specific language governing permissions and limitations under the License.
63+
64+
## SBOM
65+
66+
For an up-to-date CycloneDX SBOM, please have a look at the [SBOM](https://github.com/fossology/FOSSology.REST.dotnet/tree/master/SBOM) folder.

0 commit comments

Comments
 (0)