github-profilinator icon indicating copy to clipboard operation
github-profilinator copied to clipboard

Saving and reading config to and from the generated readmes

Open rishavanand opened this issue 4 years ago • 4 comments

Is your feature request related to a problem? Please describe. When users want to modify their readme already created with GitHub Profilinator, they need to start from scratch as there is no config option.

Describe the solution you'd like At markdown generation, the config can be added to it as comments then it can be loaded directly by providing the link to the existing readmes generated via GitHub Profilinator.

Describe alternatives you've considered An alternative would be allowing users to download the config but again they will have to manage storage, add it to the readme as comment looks like a better solution.

Additional context none

TODO

  • [ ] Add config to the generated readme code as markdown/html comment
  • [ ] Add load config button in the sidebar, that will take GitHub username or a readme link from the user and load the previously saved config in the web app.

rishavanand avatar Oct 09 '20 09:10 rishavanand

Agreed with not going with config file down solution and about the readme, user have to share the raw file link in order us to get text instead of html and find the config area and parse it.

Another solution can use adding login with github and then save the config using backend may be firebase if not our own.

smkamranqadri avatar Oct 21 '20 23:10 smkamranqadri

@smkamranqadri That's another good solution but I feel it increases the complexity of the solution by involving a backend. The config as a comment solution is simple to implement and manage. What do you think? Do you see any drawbacks to this solution?

rishavanand avatar Oct 22 '20 08:10 rishavanand

A part from user to give us raw file link, nothing I can think of.

smkamranqadri avatar Oct 25 '20 12:10 smkamranqadri

I've added TODOs for this issue. See if you can take them up.

rishavanand avatar Oct 28 '20 10:10 rishavanand