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

Update README #51

Open
fizruk opened this issue Apr 10, 2017 · 3 comments
Open

Update README #51

fizruk opened this issue Apr 10, 2017 · 3 comments

Comments

@fizruk
Copy link
Owner

fizruk commented Apr 10, 2017

README does not currently mention Form, LenientData or any of the useful helper functions.
Also it does not get typechecked. We should probably update README to give an up-to-date description of what this package provides.

@phadej
Copy link
Collaborator

phadej commented Apr 11, 2017

markdown-unlit and doctest doesn't seem to play well together, do they?

One option is to make Web.FormUrlEncoded.Tutorial with most tutorial content from README. (unfortunately we don't have single main module in this package)

@fizruk
Copy link
Owner Author

fizruk commented Feb 21, 2018

@phadej do you think we should restructure modules?

Currently we have

Web
├── FormUrlEncoded
├── HttpApiData
└── Internal
    ├── FormUrlEncoded
    └── HttpApiData

And I would like to add some support for multipart/form-data soon.
It might be good to restructure modules in the same release we add that.

How about making Web.HttpApiData main module like this?

Web
└── HttpApiData
    ├── Internal
    │   ├── FormUrlEncoded
    │   ├── HttpApiData
    │   └── MultiPartFormData
    ├── FormUrlEncoded
    ├── HttpApiData
    ├── MultiPartFormData
    └── Tutorial

@phadej
Copy link
Collaborator

phadej commented Feb 21, 2018 via email

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

No branches or pull requests

2 participants