Skip to content

Commit f4330ce

Browse files
committed
chore: rename repository and update contributing guidelines
1 parent cbc1bac commit f4330ce

File tree

17 files changed

+60
-50
lines changed

17 files changed

+60
-50
lines changed

.github/CONTRIBUTING.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,34 @@
22

33
### Issue
44

5-
1. Make sure you're using the latest version, check [releases](https://github.com/Simonwep/selection/releases/tag/2.1.2) for that.
6-
2. [Use the search](https://github.com/Simonwep/selection/search?type=Issues), maybe there is already an answer.
7-
3. If not found, [create an issue](https://github.com/Simonwep/selection/issues/new), please dont forget to carefully describe it how to reproduce it / pay attention to the issue-template.
5+
* Make sure you're using the latest version, check [releases](https://github.com/simonwep/viselect/releases/tag/2.1.2) for that.
6+
* [Use the search](https://github.com/simonwep/viselect/search?type=Issues), maybe there is already an answer.
7+
* If not found, [create an issue](https://github.com/simonwep/viselect/issues/new), please don't forget to carefully describe it how to reproduce it / pay attention to the issue-template.
88

99
***
1010

1111
### Pull Request
1212

13-
1. Pull requests only into the [master](https://github.com/Simonwep/selection/tree/master) branch.
13+
* Pull requests only into the [master](https://github.com/simonwep/viselect/tree/master) branch.
14+
* Make sure to use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/):
15+
- `docs: ` - for changes in the documentation.
16+
- `feat([package]): ` - for new features in the corresponding package.
17+
- `fix([package]): ` - for bug fixes in the corresponding package.
18+
- `refactor([package]): ` - for changes in the code that neither fixes a bug nor adds a feature.
19+
- `chore: ` - for changes in the build process or auxiliary tools.
1420

1521
***
1622

17-
#### Setup
23+
### Working on the library
1824

1925
This project requires [pnpm](https://pnpm.io) and [node](https://nodejs.org/en/).
20-
21-
1. Fork this repo on [GitHub](https://github.com/Simonwep/selection).
26+
27+
1. Fork this repo on [GitHub](https://github.com/simonwep/viselect).
2228
2. Check out the master locally.
2329
3. From your local repro run `pnpm install`.
24-
4. Run `pnpm start dev`.
30+
4. Run `pnpm start dev` to start a dev server for all packages.
31+
32+
#### Working on the docs
33+
34+
This project uses [vitepress](https://vitepress.dev/) for the documentation.
35+
Use the `docs:` commands to work on the documentation.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ assignees: ''
77

88
---
99

10-
**Use [discussions](https://github.com/Simonwep/selection/discussions).**
10+
**Use [discussions](https://github.com/simonwep/viselect/discussions).**

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515
<a href="https://github.com/sponsors/Simonwep"><img
1616
alt="Support me"
1717
src="https://img.shields.io/badge/github-support-6a15cc.svg"></a>
18-
<img alt="version" src="https://img.shields.io/github/lerna-json/v/Simonwep/selection?color=%233d24c9&label=version">
18+
<img alt="version" src="https://img.shields.io/github/lerna-json/v/simonwep/viselect?color=%233d24c9&label=version">
1919
<a href="https://www.buymeacoffee.com/aVc3krbXQ"><img
2020
alt="Buy me a coffee"
2121
src="https://img.shields.io/badge/%F0%9F%8D%BA-buy%20me%20a%20beer-%23FFDD00"></a>
22-
<a href="https://github.com/Simonwep/selection/actions?query=workflow%3ACI"><img
22+
<a href="https://github.com/simonwep/viselect/actions?query=workflow%3ACI"><img
2323
alt="Build Status"
24-
src="https://github.com/Simonwep/selection/workflows/CI/badge.svg"></a>
24+
src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"></a>
2525
<img alt="gzip size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/vanilla/dist/viselect.umd.js?compression=gzip">
2626
<img alt="brotli size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/vanilla/dist/viselect.umd.js?compression=brotli">
2727
<a href="https://v3.vuejs.org"><img
@@ -48,7 +48,6 @@
4848
* 📱 Mobile / touch support
4949
* 🖱 Vertical and horizontal scroll support
5050
* 💪 Hardened (over 3 years old and used in many apps)
51-
* 🖼 Support for major frameworks (WIP)
5251

5352
### Getting started
5453

docs/pages/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ outline: deep
55
# Text is selected by default when dragging the mouse over text
66

77
To not interfere with text-selection, selection-js won't prevent any default events anymore (as of `v2.0.3`).
8-
This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/Simonwep/selection/pull/99), reported in [#103](https://github.com/Simonwep/selection/issues/103)).
8+
This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/simonwep/viselect/pull/99), reported in [#103](https://github.com/simonwep/viselect/issues/103)).
99
If you don't care about text-selection, add the following to the container where all your selectables are located:
1010

1111
```css

packages/preact/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
<a href="https://www.buymeacoffee.com/aVc3krbXQ"><img
1919
alt="Buy me a coffee"
2020
src="https://img.shields.io/badge/%F0%9F%8D%BA-buy%20me%20a%20beer-%23FFDD00"></a>
21-
<a href="https://github.com/Simonwep/selection/actions?query=workflow%3ACI"><img
21+
<a href="https://github.com/simonwep/viselect/actions?query=workflow%3ACI"><img
2222
alt="Build Status"
23-
src="https://github.com/Simonwep/selection/workflows/CI/badge.svg"></a>
23+
src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"></a>
2424
<img alt="gzip size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/preact/dist/viselect.mjs?compression=gzip">
2525
<img alt="brotli size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/preact/dist/viselect.mjs?compression=brotli">
2626
<a href="https://v3.vuejs.org"><img
@@ -46,7 +46,7 @@
4646
<br>
4747

4848
> [!NOTE]
49-
> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/selection/tree/master/packages/vanilla).
49+
> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/viselect/tree/master/packages/vanilla).
5050
> The core API is fairly simple, if you want to have full control over it, you should roll out your own wrapper in your app.
5151
5252
### Installation
@@ -68,7 +68,7 @@ Last but not least, you'll need to add some basic styles to make your selection-
6868
```
6969

7070
Additionally, to not interfere with text-selection, selection-js won't prevent any default events anymore (as of `v2.0.3`).
71-
This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/Simonwep/selection/pull/99), reported in [#103](https://github.com/Simonwep/selection/issues/103)).
71+
This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/simonwep/viselect/pull/99), reported in [#103](https://github.com/simonwep/viselect/issues/103)).
7272
If you don't care about text-selection, add the following to the container where all your selectables are located:
7373

7474
```css

packages/preact/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
"version": "3.9.0",
44
"description": "Preact wrapper around the viselect vanilla library",
55
"author": "Simon Reinisch <contact@reinisch.io>",
6-
"bugs": "https://github.com/Simonwep/selection/issues",
7-
"homepage": "https://github.com/Simonwep/selection#readme",
8-
"repository": "git+https://github.com/Simonwep/selection.git",
6+
"bugs": "https://github.com/simonwep/viselect/issues",
7+
"homepage": "https://github.com/simonwep/viselect#readme",
8+
"repository": "git+https://github.com/simonwep/viselect.git",
99
"license": "MIT",
1010
"main": "./dist/viselect.umd.js",
1111
"module": "./dist/viselect.mjs",

packages/preact/vite.config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import banner from 'vite-plugin-banner';
44
import dts from 'vite-plugin-dts';
55
import {version} from './package.json';
66

7-
const header = `/*! @viselect/preact v${version} MIT | https://github.com/Simonwep/selection/tree/master/packages/preact */`;
7+
const header = `/*! @viselect/preact v${version} MIT | https://github.com/simonwep/viselect/tree/master/packages/preact */`;
88

99
export default defineConfig(env => ({
1010
root: env.mode === 'production' ? '.' : './demo',

packages/react/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
<a href="https://www.buymeacoffee.com/aVc3krbXQ"><img
1919
alt="Buy me a coffee"
2020
src="https://img.shields.io/badge/%F0%9F%8D%BA-buy%20me%20a%20beer-%23FFDD00"></a>
21-
<a href="https://github.com/Simonwep/selection/actions?query=workflow%3ACI"><img
21+
<a href="https://github.com/simonwep/viselect/actions?query=workflow%3ACI"><img
2222
alt="Build Status"
23-
src="https://github.com/Simonwep/selection/workflows/CI/badge.svg"></a>
23+
src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"></a>
2424
<img alt="gzip size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/react/dist/viselect.mjs?compression=gzip">
2525
<img alt="brotli size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/react/dist/viselect.mjs?compression=brotli">
2626
<a href="https://v3.vuejs.org"><img
@@ -46,7 +46,7 @@
4646
<br>
4747

4848
> [!NOTE]
49-
> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/selection/tree/master/packages/vanilla).
49+
> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/viselect/tree/master/packages/vanilla).
5050
> The core API is fairly simple, if you want to have full control over it, you should roll out your own wrapper in your app.
5151
5252
### Installation
@@ -71,7 +71,7 @@ Last but not least, you'll need to add some basic styles to make your selection-
7171
```
7272

7373
Additionally, to not interfere with text-selection, selection-js won't prevent any default events anymore (as of `v2.0.3`).
74-
This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/Simonwep/selection/pull/99), reported in [#103](https://github.com/Simonwep/selection/issues/103)).
74+
This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/simonwep/viselect/pull/99), reported in [#103](https://github.com/simonwep/viselect/issues/103)).
7575
If you don't care about text-selection, add the following to the container where all your selectables are located:
7676

7777
```css

packages/react/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
"version": "3.9.0",
44
"description": "React wrapper around the viselect vanilla library",
55
"author": "Simon Reinisch <contact@reinisch.io>",
6-
"bugs": "https://github.com/Simonwep/selection/issues",
7-
"homepage": "https://github.com/Simonwep/selection#readme",
8-
"repository": "git+https://github.com/Simonwep/selection.git",
6+
"bugs": "https://github.com/simonwep/viselect/issues",
7+
"homepage": "https://github.com/simonwep/viselect#readme",
8+
"repository": "git+https://github.com/simonwep/viselect.git",
99
"license": "MIT",
1010
"main": "./dist/viselect.umd.js",
1111
"module": "./dist/viselect.mjs",

packages/react/vite.config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import banner from 'vite-plugin-banner';
44
import dts from 'vite-plugin-dts';
55
import {version} from './package.json';
66

7-
const header = `/*! @viselect/react v${version} MIT | https://github.com/Simonwep/selection/tree/master/packages/react */`;
7+
const header = `/*! @viselect/react v${version} MIT | https://github.com/simonwep/viselect/tree/master/packages/react */`;
88

99
export default defineConfig(env => ({
1010
root: env.mode === 'production' ? '.' : './demo',

0 commit comments

Comments
 (0)