search

b3by / atom-clock

Place a clock or calendar in your status bar
MIT License
96 stars 90 forks source link

Exclude non-essential files #52

Closed vinkla closed 6 years ago

vinkla commented 7 years ago

This way the users of this package doesn't have to download non-essential files which aren't necessary for the package to function. Such as files used for development (docs, tests, .travis.yml, etc).

Happy Hacktoberfest!

ftm commented 7 years ago

I think README.md needs to be kept in order for Atom to display it when the package is installed

b3by commented 7 years ago

Thank you for the commits. That's right, the readme is needed, and probably the image folder too.

vinkla commented 7 years ago

I think README.md needs to be kept in order for Atom to display it when the package is installed

@frasertmay the README.md file is excluded from the list.

Thank you for the commits. That's right, the readme is needed, and probably the image folder too.

@b3by I would argue against keeping the images directory. We don't want to force the users of this package to download 1,2 megabytes of data they probably wont use. If we do the math of how many times this package has been downloaded we've used over 300 gigabytes of bandwidth data.

Instead I think we should upload the images to GitHub's CDN.

vinkla commented 6 years ago

Any update on this? Will you merge or should I close?

b3by commented 6 years ago

Sorry about the super late response. I'll merge this after Monday (quite sure I'll do it on Tuesday). Crazy busy at work :(

ftm commented 6 years ago

If you're going to remove the images folder then the URLs in the README need pointing to the CDN or they won't show up in Atom