From 3900af5f9171bf4e62bf6551c10c5eb385c9b902 Mon Sep 17 00:00:00 2001 From: Ashlynne Mitchell Date: Sat, 17 May 2025 10:36:25 +0000 Subject: [PATCH] docs: add LICENSE and README --- LICENSE | 20 ++++++++++++++++++++ README.md | 48 ++++++++++++++++-------------------------------- 2 file(s) changed, 36 insertion(s)(+), 32 deletion(s)(-) diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +MIT License + +Copyright (c) 2025 comet.sh + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,38 +1,22 @@ -# sv - -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). - -## Creating a project - -If you're seeing this, you've probably already done this step. Congrats! - -```bash -# create a new project in the current directory -npx sv create - -# create a new project in my-app -npx sv create my-app -``` - -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: - -```bash -npm run dev +# Comet -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` +> Music on ATProto. -## Building +Comet's goal is to provide an open, decentralised alternative for uploading and +sharing your music with others. -To create a production version of your app: +Follow along on Bluesky! [@comet.sh](https://bsky.app/profile/comet.sh) / +[@ovyerus.com](https://bsky.app/profile/ovyerus.com) -```bash -npm run build -``` +This project is in the _very_ early stages and a lot will change over time, +especially as this is my first foray into the ATProtocol ecosystem. Stuff will +be a bit messy for a while. Feel free to contribute and voice your opinions! -You can preview the production build with `npm run preview`. +## Current Status -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. +- [ ] Experimental Lexicons + - [x] Records + - [ ] Queries +- [ ] PoC Node/Bun AppView (eventually I want to rewrite in something like Rust + or Elixir. TBD) +- [ ] Clients -- tangled.sh