search

tillitis / tkey-ssh-agent

SSH Agent for TKey, the flexible open hardware/software USB security key 🔑
https://www.tillitis.se
BSD 2-Clause "Simplified" License
131 stars 15 forks source link

README.md: Reword stuff #90

Closed sagehane closed 1 year ago

sagehane commented 1 year ago

I found the README a bit hard to read so here's some suggestions. I'm not comfortable with all my changes though. Also, I think removing instances of "you" would make the text read nicer.

sagehane commented 1 year ago

So, I guess I should squash the commits once all of this is done?

Also, is there supposed to be a max length for the sentences? It seemed like the goal is to try to get things under 75-ish characters per line.

mchack-work commented 1 year ago

We're currently in the process of splitting this repo into several repos: the Go packages, the device apps and the commands... The documentation in the README is mostly copied to the Developer Handbook: https://dev.tillitis.se/ (repo here https://github.com/tillitis/dev-tillitis )

Would it be alright if we applied your changes there instead and attribute you @sagehane ? Perhaps manually since it's a little spread out.

sagehane commented 1 year ago

Ah, yeah, that's fine.

dehanj commented 1 year ago

I have added the rewording applicable to the dev-handbook. Thanks for the input, closing this PR.