search

Nordix / bomres

Software Bill-of-Material Resolver
Apache License 2.0
7 stars 6 forks source link

Adding baseline documentation to the README #6

Closed gkunz closed 2 years ago

gkunz commented 2 years ago

Adding initial documentation to the repo by extending the README. More updates to come.

Signed-off-by: Georg Kunz georg.kunz@ericsson.com

hans-lammda commented 2 years ago

Would be nice with support for PlantUML for pictures.

hans-lammda commented 2 years ago

Hello,

Based on my design of lockfile I updated the API spec.

Swagger UI (t2data.com) https://lb.t2data.com/resolver/alpine/v1/ui/

I also remove the instruction how to run the resolver by extracting code for the container.

// Hans

From: Georg Kunz @.> Sent: den 25 januari 2022 15:50 To: Nordix/bomres @.> Cc: Hans Thorsén @.>; Review requested @.> Subject: Re: [Nordix/bomres] Adding baseline documentation to the README (PR #6)

@gkunz https://protect2.fireeye.com/v1/url?k=31323334-501d5122-313273af-454445555731-acb22338bafa4afd&q=1&e=9377bd3f-dc36-4ba1-b36f-f2833a0f8ef8&u=https%3A%2F%2Fgithub.com%2Fgkunz requested your review on: #6 https://protect2.fireeye.com/v1/url?k=31323334-501d5122-313273af-454445555731-defd03c7818253d4&q=1&e=9377bd3f-dc36-4ba1-b36f-f2833a0f8ef8&u=https%3A%2F%2Fgithub.com%2FNordix%2Fbomres%2Fpull%2F6 Adding baseline documentation to the README.

— Reply to this email directly, view it on GitHub https://protect2.fireeye.com/v1/url?k=31323334-501d5122-313273af-454445555731-f4d747a650092c55&q=1&e=9377bd3f-dc36-4ba1-b36f-f2833a0f8ef8&u=https%3A%2F%2Fgithub.com%2FNordix%2Fbomres%2Fpull%2F6%23event-5950431531 , or unsubscribe https://protect2.fireeye.com/v1/url?k=31323334-501d5122-313273af-454445555731-fde95b5b2b6abf77&q=1&e=9377bd3f-dc36-4ba1-b36f-f2833a0f8ef8&u=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAXMBLJRM4XF2NTEPEIXTTI3UX22BTANCNFSM5MYO2KZA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://protect2.fireeye.com/v1/url?k=31323334-501d5122-313273af-454445555731-aa66f83e1a88601a&q=1&e=9377bd3f-dc36-4ba1-b36f-f2833a0f8ef8&u=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Dcom.github.android%26referrer%3Dutm_campaign%253Dnotification-email%2526utm_medium%253Demail%2526utm_source%253Dgithub . You are receiving this because your review was requested. https://github.com/notifications/beacon/AXMBLJWURBI4RXENGKRJR5DUX22BTA5CNFSM5MYO2KZKYY3PNVWWK3TUL52HS4DFWZEXG43VMVCXMZLOORHG65DJMZUWGYLUNFXW5KTDN5WW2ZLOORPWSZGPAAAAAALCVRQSW.gif Message ID: @. @.> >