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 #4

Closed
AndreVarandas opened this issue Oct 3, 2020 · 7 comments · Fixed by #9
Closed

Update readme #4

AndreVarandas opened this issue Oct 3, 2020 · 7 comments · Fixed by #9
Assignees
Labels

Comments

@AndreVarandas
Copy link
Owner

Is your feature request related to a problem? Please describe.
We want to update our placeholder readme file!

Describe the solution you'd like
Here is what we want to add, completely replacing what we currently have

Fortnite Api Wrapper

Fortnite api wrapper is a dart library for interacting with the https://fortnite-api.com/.

Installation

Use the package manager ... to install foobar.

pub get ....

Usage

... TODO

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Describe alternatives you've considered
There is no documentation usage yet, and the package is not yet published, but feel free to add in more details to it.

@AndreVarandas AndreVarandas added this to To do in Project Board via automation Oct 3, 2020
@rustiever
Copy link
Contributor

Hi! @AndreVarandas can i solve this issue

@AndreVarandas
Copy link
Owner Author

Hi @rustiever thanks for reaching out!
I'm assigning it to you 👍

@rustiever
Copy link
Contributor

ok what should write in usage section? please don't mind i'm newbie
can we use some linters like effective_dart, lint, linter, pedantic etc? so that i can bring that icons to the readme

@AndreVarandas
Copy link
Owner Author

No issue, I'm also a newbie not even aware of the available linters for dart, but I'm all in for that!

@rustiever
Copy link
Contributor

i resloved issue and created the pr, please merge to close the issue

@AndreVarandas
Copy link
Owner Author

Hi @rustiever I've just merged your PR. Would you like to change the issues link to the new issue link and to put the MIT license badge on a new line? Thank you!

@rustiever
Copy link
Contributor

Hi @AndreVarandas , How to do that? i've done splitting the line in readme file and created the pr

Project Board automation moved this from To do to Done Oct 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging a pull request may close this issue.

2 participants