Sync readme.md from github too for descriptions

[jerone]

Since OUJS search Github for .user.js files and we also support Markdown, should it also search for readme.md files in the same folder as the userscripts are found and use that for the description field...

[sizzlemctwizzle]

Sounds great. This will work fine for importing, but how should we handle the webhook. Listen for changes to the README? Treat it the same way we treat scripts (webhook just overwrites changes on OUJS)? Ignore changes on GH if it's been changed on OUJS? If a user tries to change that section on OUJS, should we send them to GH to edit it?

I definitely want this in some form, but it wasn't in my initial plans for the first three milestones and I don't know if I'll have time to squeeze it in so I'm assigning it to the fourth milestone.

[jerone]

Definitely a feature for later.

I like the way how GreaseFork works with sync. Give the user access to the sync feature.

[studgeek]

Also see #96 where I suggest defining a common script file structure with GreasyFork also.

[TriMoon]

I don't agree with using the readme.md for the scripts.
Because people could have more than one userscript inside their GH-repo designated for their userscripts.
The readme.md would only explain things inside the repo, but individual scripts could have totaly different descriptions inside....

[Zren]

Easy enough.

scriptInfoMdFilename = None
if numScripts(repo) == 1:
    scriptInfoMdFilename = '/ReadMe.md' # Case Insensitive

# /scripts/1234214.user.js
# /scripts/1234214.md
scriptMdFilename = scriptPath + scriptNameWithoutFileExt + '.md'
if fileExists(scriptMdFilename):
    scriptInfoMdFilename = scriptMdFilename

With that, you could have a repo with only 1 script, and have both a ReadMe.md and a scriptName.md for the synced script info.

[sizzlemctwizzle]

With that

I agree. I think that is the best way to handle this.

[Martii]

Did we decide on a naming syntax for this?

'/ReadMe.md'

This could work... but wanted to note the user-content accelerator arrows will fail on GH with the current README.md ... they are quite complex at times so it's probably not suggested to handle this in our pages.

Slapping some other naming suggestions (maybe more at a later point)

• README.oujs.md
• README.OUJS.md

[reek]

HI all,

I vote 👍 for adding this feature, it will render a great service to all those who have userscript hosted on different plattform

Regards
Reek