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

Open
Devsome opened this issue Sep 2, 2020 · 10 comments
Open

Readme #2

Devsome opened this issue Sep 2, 2020 · 10 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest Hacktoberfest 2020 help wanted Extra attention is needed

Comments

@Devsome
Copy link

Devsome commented Sep 2, 2020

Create a Readme with the main information of your project.

  1. What does it do?
  2. Who could use it?
  3. How to use it?
  4. What do you need?
@swetankraj swetankraj added documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest Hacktoberfest 2020 labels Sep 2, 2020
@swetankraj
Copy link
Owner

@Devsome Thank you for bringing this out. I'll try to add some documentation. Or shall I leave this for contribution?

@Devsome
Copy link
Author

Devsome commented Sep 2, 2020

Guess you could leave this for contribution, there are some beginners who wants to contribute on a unknown project 👍

@swetankraj
Copy link
Owner

Sounds good I'll add few details here about project then.

@withewolf-dev
Copy link

I would love to work on this

@swetankraj
Copy link
Owner

@withewolf-dev Thank you for your interest. Create a readme file in the main directory and update it with point number 1,2,3 mentioned by @Devsome .

  1. "Dark Netflix API is an open source RESTful API for all things Dark."

  2. "For the fans, by the fans! You could use our API on any of your major projects. Just make sure to point a link to this repository."

  3. The site https://dark-api.herokuapp.com/ mentions two endpoints as of now, Use these 2 of them in readme for point 3 and also what type of HTTP request it is in brackets. Try to make a table for this. Columns can be HTTP method, Endpoint and Description.

@Devsome I hope these are enough, feel free to add anything you'd like.

@swetankraj swetankraj added the help wanted Extra attention is needed label Sep 10, 2020
@daedraMex
Copy link
Contributor

I could do the README.md file :D

@swetankraj
Copy link
Owner

@Any28Flo thank you for your interest. Since @withewolf-dev hasn't responded yet, Please go ahead. Note that we do now have 4 endpoints 🎉, please do as necessary and as always feel free to unleash your creativity.

@daedraMex
Copy link
Contributor

Hey @swetankraj I made some changes on the README.md file. What do yo think? But I send my PR and you aprove and merge on october. What are the steps to participate in hacktoberfest and count my PR?

@swetankraj
Copy link
Owner

@Any28Flo sure I'll check your PR and assign this to you. And will merge only on October :D Rest assured you can work on this for Hacktoberfest. I do have to check FAQs and will put up a document and steps soon.

@daedraMex
Copy link
Contributor

Hey @swetankraj please check my PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest Hacktoberfest 2020 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants