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

Readme #12

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Readme #12

wants to merge 2 commits into from

Conversation

twitchy-jsonp
Copy link
Contributor

This is just a draft - I havent made the table documenting all the different expressions and how to use them yet. Let me know if I am on the right track, I'll finish off this PR if yes.


The following expressions are implemented for use in rule logic:

TODO
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should just link to godoc instead of maintaining a separate list. It will just go stale.


#### Drop outgoing packets to 1.2.3.4

```go
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we link to a compiled example in godoc instead? That way, it’ll always be up to date.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a huge fan of long examples in godoc, could we have an 'examples' folder with a bunch instead?

Alternatively, I'm writing up heaps with this package on my blog. I don't think it would be right to link to my blog, but maybe we could put equivalent content in a wiki on this repo?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An examples directory works, too, but please make them be testable.

I don’t mind linking to your blog (in addition). That might be a more pragmatic alternative than wikis, which only make sense for larger projects where there’s enough motivation around to keep them up-to-date.

@@ -6,11 +6,78 @@ implemented in pure Go, i.e. does not wrap libnftnl.

This is not an official Google product.

## Breaking changes
## Alpha status
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you keep the “Breaking changes” in the heading please? I’d like to have it prominently pointed out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants