kunaljainwin / Starflix

A sorted answer to "What to watch ?" #hacktoberfest
https://starflix-movies-5a210.firebaseapp.com
9 stars 6 forks source link

Improvements in Markdown specification, formatting, sample codes and added more info in sections #12

Closed james-sabel closed 1 year ago

james-sabel commented 1 year ago

@kunaljainwin

Regarding Issue #1:

I made improvements to the current documentation. I'd appreciate it if you could review it and give me some feedback.

I believe we don't need to get into more details on how to get the API key from TMDB, since the steps are already on their website. Unless there's some specific instructions you think are worth mentioning.

By the way, while I was working on this, I noticed a typo in the sample code for the "fetchDocumantaries" request. I believe it should be "fetchDocumentaries". I kept the original writing so I wouldn't break the code, but maybe you'll want to fix it.

Let me know if there's any additional changes you'd like to see!

james-sabel commented 1 year ago

Thanks its good, but why java in line 13 ,

This is to specify which programming language is being used in the sample code. This is good practice when writing code blocks in Markdown, so GitHub knows which formatting to use for reserved words.

kunaljainwin commented 1 year ago

ok cool👍