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

Saving and reading config to and from the generated readmes #52

Open
2 tasks
rishavanand opened this issue Oct 9, 2020 · 4 comments
Open
2 tasks

Saving and reading config to and from the generated readmes #52

rishavanand opened this issue Oct 9, 2020 · 4 comments
Labels
enhancement New feature or request Hacktoberfest

Comments

@rishavanand
Copy link
Owner

rishavanand commented Oct 9, 2020

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.
@smkamranqadri
Copy link
Contributor

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.

@rishavanand
Copy link
Owner Author

@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?

@smkamranqadri
Copy link
Contributor

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

@rishavanand
Copy link
Owner Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants