diff --git a/README.md b/README.md index d9eb2ea..45276cb 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,9 @@ a frontend dashboard with stats for your ATProto PDS. ### installing -clone the repo, install dependencies using deno: +clone the repo, copy `config.ts.example` to `config.ts` and edit it to your liking. + +then, install dependencies using deno: ```sh deno install diff --git a/config.ts b/config.ts.example similarity index 52% rename from config.ts rename to config.ts.example index 8d09cf6..70caf9c 100644 --- a/config.ts +++ b/config.ts.example @@ -3,14 +3,14 @@ */ export class Config { /** - * The base URL of the PDS (Personal Data Server) - * @default "https://pds.witchcraft.systems" + * The base URL of the PDS (Personal Data Server). + * @default none */ - static readonly PDS_URL: string = "https://pds.witchcraft.systems"; + static readonly PDS_URL: string = ""; /** * The base URL of the frontend service for linking to replies/quotes/accounts etc. - * @default "https://deer.social" + * @default "https://deer.social" // or https://bsky.app if you're boring */ static readonly FRONTEND_URL: string = "https://deer.social"; @@ -24,13 +24,14 @@ export class Config { static readonly MAX_POSTS: number = 20; /** - * Footer text for the dashboard, you probably want to change this + * Footer text for the dashboard, you probably want to change this. Supports HTML. + * @default "Source (github mirror)" */ static readonly FOOTER_TEXT: string = - "Astrally projected from witchcraft.systems

Source (github mirror)"; + "Source (github mirror)"; /** - * Whether to show the posts that are in the future + * Whether to show the posts with timestamps that are in the future. * @default false */ static readonly SHOW_FUTURE_POSTS: boolean = false;