Commit graph

19 commits

Author SHA1 Message Date
bkellam
fe3817b9a5 Rename organization to sourcebot-dev 2024-09-29 14:39:17 -07:00
Brendan Kellam
d0d104a1e1
Readme V3 + config examples (#12) 2024-09-29 14:17:43 -07:00
Michael Sukkarieh
e089fd5e1e
read me v2 (#10)
* add initial sections for new getting started section in README

* add missing section reference

* simplify english in workspace section

* additional language around mounting and running

* nit, browser language

* add info on how to edit config file and cleanup old docs

* add features section

* made readme more concise

* fix github icon

* missed a github icon

* fixed links in build section

* remove CONFIG_PATH setting in one command instruction:
2024-09-28 16:51:55 -07:00
bkellam
bf85c62132 nit: invert README github icons when in dark mode 2024-09-24 21:56:17 -07:00
Michael Sukkarieh
03fc50afd2
various README fixes (#3)
* add instructions on adding GITHUB_TOKEN as env variable on machine

* add .github-token to gitignore and add additional info in build instructions

* remove github-token from gitignore because its meant to be in home dir. Bold this part in the README so its more clear

* add ctags installation instructions to readme

* link to ctags repo in README

* remove unnecessary line change in gitignore
2024-09-19 13:28:10 -07:00
Michael Sukkarieh
c5b53c2d6c
Sanitize posthog data and add more info in README (#4)
* remove page view provider

* sanatize current_url and ip properties in all posthog events

* add posthog usage info in README

* remove unneccessary ip property removal since we disable ip collection on posthog side

* add back ip sanitization on client side (we disabled it on server side but may as well also clear it on client) and revise README on telemetry

* add typo with asterisks in readme

* small grammar fix in README
2024-09-19 13:22:13 -07:00
bkellam
0f4b610c4c Add placeholder demo gif + improvements to README 2024-09-18 00:22:17 -07:00
bkellam
1d8335b699 remove breaklines 2024-09-17 23:09:05 -07:00
bkellam
4355567351 indent README 2024-09-17 23:08:16 -07:00
bkellam
b9694c9c76 document building locally 2024-09-17 23:06:00 -07:00
Brendan Kellam
c5edc1b802
remove todos section (#2) 2024-09-17 15:10:07 -07:00
bkellam
3ef9be2b6b Add PostHog telemetry support 2024-09-16 21:37:34 -07:00
bkellam
c566791c5a fix badge 2024-09-07 17:20:17 -07:00
bkellam
0c0ffe847d wip on README 2024-09-07 17:17:32 -07:00
bkellam
abf8ecef5f experiment with non-background logos 2024-09-07 15:59:47 -07:00
bkellam
c8cd4a66ca Add logo to readme and start writing instructions 2024-09-07 15:51:36 -07:00
bkellam
1b34a5274c Empty readme 2024-09-04 21:34:21 -07:00
bkellam
e99565edcd init nextjs project 2024-08-23 13:54:13 -07:00
Brendan Kellam
b43aa46889
Initial commit 2024-08-23 13:40:38 -07:00