Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a quick start example to README #148

Open
durkinza opened this issue Apr 10, 2024 · 0 comments
Open

Add a quick start example to README #148

durkinza opened this issue Apr 10, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@durkinza
Copy link
Owner

The README covers detailed steps of each portion of the Firewall documentation, but it fails to provide an easy to view example of what the firewall setup could look like.

Having an example/quickstart section that shows the basic setup of a firewall would be helpful to people that are looking at using this package.

The example only needs to represent the setup code for the Network Firewall, and any immediate dependencies such as the Firewall Policy class. But it doesn't need to show the whole CDK project structure.
The example could represent one of the two "opinionated" approaches that is described in the README, or possibly use the integration test example that is already written.

@durkinza durkinza added the enhancement New feature or request label Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant