Добавить README или детализировать инструкцию по настройке

[vpkopylov]

Добрый день!
XKeen отличный софт, но не хватает официальной документации прочитав которую технически грамотный человек мог бы условно за 10 минут получить работающий прокси.
Есть статья на хабре которая очень хорошо описывает этап установки, но не описывает последовательно настройку. Еще есть инструкция, но в ней мало деталей. В итоге приходится собирать информацию из разных источников и настраивать методом проб и ошибок. Также, думаю, нехватка документации увеличивает количество вопросов в личку и форумы, о чем есть свидетельства

Чего именно не хватает:

1. Пошагового описания процесса настройки до этапа работающего функционала. В разных случаях может отличаться настройка параметров подключения к vps, но можно взять за основу наиболее типовой сценарий(и), например, vless+reality. Это наиболее важный пункт.
2. Более детального описания вариантов подключения клиентов и проброса портов. (Все устройства без политики XKeen/ конкретный список клиентов с политикой, проброс всех или конкретных портов).
3. Более детального описания режимов работы прокси и рекомендации по выбору. В статье написано что самый простой вариант это socks прокси и настройка прокси клиента в роутере и есть свежий туториал который этому следует, но в комментах к нему пишут, что это не лучший вариант и в инструкции он даже не описан. При этом самым простым вариантом выглядит использование дефолтной конфигурации inbounds, так как это не требует ничего настраивать в веб-интерфейсе и сразу дает работающий сервер.
4. Описания включенных в проект geosites, рекомендаций в каких случаях использовать и примеров настройки. На моем стареньком роутере с небольшой оперативкой отлично подошел режим белого списка через zkeen, а остальные варианты потребляли слишком много ресурсов, но понял я это "методом тыка".

Вижу, что в статье упоминаются планы написания цикла статей в будущем, но т.к. люди сталкиваются с проблемами уже сейчас и возможно распространяют не лучшие решения хочется чтобы это было поскорее. README на гитхабе выглядит хорошим вариантом т.к. это первое что ассоциируется с проектом и гуглится и хочется чтобы страница была не пустой, но подойдет и доработка существующей инструкции.
Готовь участвовать/сделать PR.

[jameszeroX]

@vpkopylov
Добрый день!
Инструкцию с хабра даже не упоминайте)) Если что-то и рекомендовать, кроме авторской инструкции, то этот вариант

[vpkopylov]

Действительно не плохая инструкция, спасибо! Может быть хотя бы ссылку на нее в readme этой репы сделать? Потому что первое с чего начинаешь это официальные источники