search

arkime / aws-aio

Apache License 2.0
8 stars 3 forks source link

update readme and add contributing guide #132

Closed 31453 closed 11 months ago

31453 commented 11 months ago

License

I confirm that this contribution is made under an Apache 2.0 license and that I have the authority necessary to make this contribution on behalf of its copyright owner.

31453 commented 11 months ago

In my opinion sections "How to run the AWS All-in-One CLI" through "Performing CDK Bootstrap" should be removed from this readme and included in our website on a specific Arkime AWS AIO page (I can help create this!). I think a readme for a project of this scale should be more of an overview. Then there should be links to documentation on the details.

awick commented 11 months ago

I don't disagree about moving to a web page, but lets get a README done and then do a second iteration. :)

31453 commented 11 months ago

We should include a list of all the command-line parameters including defaults and descriptions.