search

ykdojo / kaguya

A ChatGPT plugin that allows you to load and edit your local files in a controlled way, as well as run any Python, JavaScript, and bash script.
http://kaguya.ai/
MIT License
1.2k stars 191 forks source link

Organize README a bit better #33

Open ykdojo opened 1 year ago

ykdojo commented 1 year ago

Move the API endpoints section into a separate file and add more details about how to get started with Kaguya - install it as a ChatGPT plugin and move all files you want ChatGPT to have access to, to the FILES directory.

ykdojo commented 1 year ago

Related issue: #18

ThirDecade2020 commented 1 year ago

Helloooo - so move API endpoints and expanded installation directions (getting started guide) from original README to new README file? How detailed do you want to get when it comes to installation directions, include actual code or more high level info?

ykdojo commented 1 year ago

We added more details since I created this issue, and I feel like it's already at a pretty good state - what do you think?

I think the API endpoints should be in a separate file, but everything else can stay in README.

ThirDecade2020 commented 1 year ago

README looks good now with Custom Instructions too can update as time goes on - confused users can consult Discord for help. Stick API endpoints in new README in 'Pages' directory is what I would try. You can assign me here if all good.

ykdojo commented 1 year ago

Stick API endpoints in new README in 'Pages' directory is what I would try.

I'm not sure what you mean here exactly?

ThirDecade2020 commented 1 year ago

You mentioned 'I think the API endpoints should be in a separate file, but everything else can stay in README' above so my point was to remove that section from README and create a new README within 'pages' directory of repo where api stuff is located. Maybe I'm confused here.

ykdojo commented 1 year ago

No actually that makes sense! Appreciate the clarification

ThirDecade2020 commented 1 year ago

Final decision to leave API endpoints in README, or move to another file in 'Pages' directory? Feel free to assign me if you want to move forward on this.

ykdojo commented 1 year ago

I think moving it to the pages directory makes sense