commit 4686bfb50b17a705483ed9e70d07b63fce9987ba
parent 6f6cd060ecd375754ff089f4331e9399bf78ad74
Author: mokou <mokou@posteo.de>
Date: Thu, 21 May 2020 15:50:50 +0200
doc: Add readme and license
Diffstat:
| A | LICENSE.md | | | 57 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| M | README.md | | | 80 | ++++++++++++++++--------------------------------------------------------------- |
2 files changed, 73 insertions(+), 64 deletions(-)
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Marisa H.
+
+Source Code: https://git.touhou.cz/mokou/koro
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules. Those rules are both obligations under that agreement and conditions to your license. Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period. If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***
diff --git a/README.md b/README.md
@@ -1,38 +1,29 @@
-_Looking for a shareable component template? Go here --> [sveltejs/component-template](https://github.com/sveltejs/component-template)_
+# koro
----
-
-# svelte app
-
-This is a project template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/sveltejs/template.
-
-To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit):
-
-```bash
-npx degit sveltejs/template svelte-app
-cd svelte-app
-```
-
-_Note that you will need to have [Node.js](https://nodejs.org) installed._
+Koro is a small tool for helping plan events by letting people indicate their available start times. It's written
+in [Svelte](https://svelte.dev), stores data in [PouchDB](https://pouchdb.com) and replicates with [CouchDB]
+(https://couchdb.apache.org). Times are locally displayed in the user's timezone with the help of JavaScript's
+`Intl` API and [DayJS](https://day.js.org). CSS is handled with [Tailwind](https://tailwindcss.com).
## Get started
Install the dependencies...
```bash
-cd svelte-app
+git clone https://git.touhou.cz/mokou/koro.git
+cd koro
npm install
```
-...then start [Rollup](https://rollupjs.org):
+...then start the Webpack dev server:
```bash
-npm run dev
+npm start
```
-Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.
-
-By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.
+Navigate to [localhost:3000](http://localhost:3000). You should see your koro running. The cool thing is that you don't even
+need a local database to work on the project - PouchDB works exactly like your own little in-browser CouchDB, and you
+can enable syncing with your local CouchDB when you're ready.
## Building and running in production mode
@@ -42,48 +33,9 @@ To create an optimised version of the app:
npm run build
```
-You can run the newly built app with `npm run start`. This uses [sirv](https://github.com/lukeed/sirv), which is included in your package.json's `dependencies` so that the app will work when you deploy to platforms like [Heroku](https://heroku.com).
-
-## Single-page app mode
-
-By default, sirv will only respond to requests that match files in `public`. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.
-
-If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for _any_ path. You can make it so by editing the `"start"` command in package.json:
-
-```js
-"start": "sirv public --single"
-```
-
-## Deploying to the web
-
-### With [now](https://zeit.co/now)
-
-Install `now` if you haven't already:
-
-```bash
-npm install -g now
-```
-
-Then, from within your project folder:
-
-```bash
-cd public
-now deploy --name my-project
-```
-
-As an alternative, use the [Now desktop client](https://zeit.co/download) and simply drag the unzipped project folder to the taskbar icon.
+This builds all required files and puts them into `public/`, which you can then deploy to your static site hosting
+service of choice.
-### With [surge](https://surge.sh/)
+## License
-Install `surge` if you haven't already:
-
-```bash
-npm install -g surge
-```
-
-Then, from within your project folder:
-
-```bash
-npm run build
-surge public my-project.surge.sh
-```
+See [LICENSE](./LICENSE.md).
