From 4e1bee6213d21a2d6799aec1db4f3d0d18725e8c Mon Sep 17 00:00:00 2001 From: Grace Kind Date: Mon, 8 Dec 2025 09:41:40 -0500 Subject: [PATCH] Update readme and add license --- LICENSE | 14 ++++++++++++++ README.md | 33 +++++++++++++++++++++++++++------ 2 files changed, 41 insertions(+), 6 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..02e99c71 --- /dev/null +++ b/LICENSE @@ -0,0 +1,14 @@ +BSD Zero Clause License + +Copyright (c) 2025 Grace Kind + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. diff --git a/README.md b/README.md index 95b7ebfe..410afb15 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,31 @@ # Impro -Icons from https://github.com/halfmage/majesticons (MIT Licensed) +Impro is a Bluesky client written in HTML, CSS, and JavaScript. It is dependency-light by design and intended to serve as a demo for implementing common Bluesky client features in vanilla JS. -Dependencies: +You can try it out here: https://impro.social -- capacitor -- lit-html -- emoji-picker-element -- HLS +## Dependencies + +Impro uses the following libraries: + +- [lit-html](https://www.npmjs.com/package/lit-html) for declarative rendering +- [Capacitor](https://capacitorjs.com/) for native builds +- [HLS.js](https://github.com/video-dev/hls.js/) for streaming video +- [emoji-picker-element](https://github.com/nolanlawson/emoji-picker-element) for emoji picker UI + +The icons are from the [Majesticons](https://github.com/halfmage/majesticons) free icon set. + +## Development + +Impro is a single-page app built with [Eleventy](https://www.11ty.dev/). To run the development server, run: + +```bash +npm run start +``` + +External libraries are included as standalone files in `lib`. In cases where bundling is needed, the libraries are bundled with [esbuild](https://esbuild.github.io/). Changes to these bundles should be rare, but can be triggered manually with the following commands: + +```bash +npm run bundle:capacitor +npm run bundle:lit-html +``` -- knotmirror 0.0.1