Skip to content

Commit

Permalink
misc: Update licence bearer and links.
Browse files Browse the repository at this point in the history
  • Loading branch information
vxern committed Oct 31, 2023
1 parent 0e46038 commit d474ae8
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 32 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.4.3

- Update licence bearer and links.

## 0.4.2

- Remove:
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 WordCollector
Copyright (c) 2023 Dorian "vxern" Oszczęda

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
Expand Down
53 changes: 29 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,39 @@
The [words](https://pub.dev/packages/words) package comprises two sets of [lints][rules] which help in development of consistent, predictable applications.
The [words](https://pub.dev/packages/words) package comprises two sets of
[lints][rules] which help in development of consistent, predictable
applications.

Two sets of linter rules are used:

* **Core lints**: Lints applicable to *all* Dart code across every platform, expected to be enforced in every code library published by [WordCollector][wordcollector], as well as in private repositories.
- **Core lints**: Lints applicable to _all_ Dart code across every platform.

* **Flutter lints**: **Core** lints + additional lints only applicable to the Flutter framework.
- **Flutter lints**: **Core** lints + additional lints only applicable to the
Flutter framework.

To learn more about lints, visit the official Dart [lints](https://pub.dev/packages/lints) package repository.
To learn more about lints, visit the official Dart
[lints](https://pub.dev/packages/lints) package repository.

## How to enable these lints

1. Add the `words` package as a developer dependency using the terminal:

```terminal
dart pub add --dev words
```
2. Create an `analysis_options.yaml` file at the root of the repository (next to `pubspec.yaml`).
3. In a Flutter project you should add:
```yaml
include: package:words/flutter.yaml
```
Otherwise:
```yaml
include: package:words/core.yaml
```
[wordcollector]: https://github.com/wordcollector

```terminal
dart pub add --dev words
```

2. Create an `analysis_options.yaml` file at the root of the repository (next to
`pubspec.yaml`).

3. In a Flutter project you should add:

```yaml
include: package:words/flutter.yaml
```
Otherwise:
```yaml
include: package:words/core.yaml
```
[vxern]: https://github.com/vxern
[rules]: https://dart.dev/tools/linter-rules
13 changes: 6 additions & 7 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
name: words
version: 0.4.2
version: 0.4.3

description: >-
A curated collection of lints for use by Dart packages to ensure
higher program safety and to promote best practices, selected and
maintained by WordCollector.
higher program safety and to promote best practices.
homepage: https://github.com/wordcollector/words
repository: https://github.com/wordcollector/words
issue_tracker: https://github.com/wordcollector/words/issues
homepage: https://github.com/vxern/words
repository: https://github.com/vxern/words
issue_tracker: https://github.com/vxern/words/issues

environment:
sdk: '>=3.0.0 <4.0.0'
sdk: ">=3.0.0 <4.0.0"

0 comments on commit d474ae8

Please sign in to comment.