Skip to content

Commit 5f3bee5

Browse files
committed
Change project README file
- Add swag - Add contributing and license information - Change structure to standard sections
1 parent 4e49e20 commit 5f3bee5

1 file changed

Lines changed: 69 additions & 3 deletions

File tree

README.md

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,47 @@
11
# solid-nextcloud
2+
3+
[![Project stage: Production Ready][project-stage-badge: Production Ready]][project-stage-page]
4+
[![License][license-shield]][license-link]
5+
[![Latest Version][version-shield]][version-link]
6+
![Maintained][maintained-shield]
7+
8+
[![PDS Interop][pdsinterop-shield]][pdsinterop-site]
9+
[![standard-readme compliant][standard-readme-shield]][standard-readme-link]
10+
[![keep-a-changelog compliant][keep-a-changelog-shield]][keep-a-changelog-link]
11+
212
A plugin to make Nextcloud compatible with Solid.
313

14+
<!-- toc -->
15+
16+
## Installation
17+
418
You can download it via the Nextcloud app store: https://apps.nextcloud.com/apps/solid
519

6-
## Development install
20+
### Manual install
21+
22+
Please follow the [install instructions](https://github.com/pdsinterop/solid-nextcloud/blob/main/INSTALL.md).
23+
24+
<!-- @TODO: ## Usage -->
25+
26+
## Contributing
27+
28+
Questions or feedback can be given by [opening an issue on GitHub][issues-link].
29+
30+
All PDS Interop projects are open source and community-friendly.
31+
Any contribution is welcome!
32+
For more details read the [contribution guidelines][contributing-link].
33+
34+
All PDS Interop projects adhere to [the Code Manifesto](http://codemanifesto.com)
35+
as its [code-of-conduct][code-of-conduct]. Contributors are expected to abide by its terms.
36+
37+
There is [a list of all contributors on GitHub][contributors-page].
38+
39+
For a list of changes see the [CHANGELOG][changelog] or [the GitHub releases page][releases-page].
40+
41+
### Development
42+
43+
#### Development install
44+
745
Clone https://github.com/pdsinterop/test-suites, cd into it, and run:
846
```sh
947
docker pull nextcloud
@@ -20,14 +58,42 @@ docker exec -u root -it server service apache2 reload
2058
Now visit https://localhost and log in as alice / alice123.
2159

2260
## Manual install
61+
2362
Please follow the [install instructions](https://github.com/pdsinterop/solid-nextcloud/blob/main/INSTALL.md).
63+
### Testing
64+
65+
#### Unattended testing
2466

25-
## Unattended testing
2667
There is a [GitHub Action](https://github.com/pdsinterop/solid-nextcloud/actions/workflows/ci.yml) that runs a [Docker-based test script](https://github.com/pdsinterop/solid-nextcloud/blob/585b968/.github/workflows/ci.yml#L29).
2768

28-
## Manual testing
69+
#### Manual testing
70+
2971
You can try out the various Solid apps that show up in the Solid App GUI inside the Nextcloud GUI on first use.
3072

3173
### Build / Deploy
3274

3375
For publishing to the Nextcloud app store see [the deploy instructions](docs/deploy.md).
76+
77+
## License
78+
79+
All code created by PDS Interop is licensed under the [MIT License][license-link].
80+
81+
[changelog]: CHANGELOG.md
82+
[code-of-conduct]: https://pdsinterop.org/code-of-conduct/
83+
[contributing-link]: https://pdsinterop.org/contributing/
84+
[contributors-page]: https://github.com/pdsinterop/solid-nextcloud/contributors
85+
[issues-link]: https://github.com/pdsinterop/solid-nextcloud/issues
86+
[releases-page]: https://github.com/pdsinterop/solid-nextcloud/releases
87+
[keep-a-changelog-link]: https://keepachangelog.com/
88+
[keep-a-changelog-shield]: https://img.shields.io/badge/Keep%20a%20Changelog-f15d30.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9IiNmZmYiIHZpZXdCb3g9IjAgMCAxODcgMTg1Ij48cGF0aCBkPSJNNjIgN2MtMTUgMy0yOCAxMC0zNyAyMmExMjIgMTIyIDAgMDAtMTggOTEgNzQgNzQgMCAwMDE2IDM4YzYgOSAxNCAxNSAyNCAxOGE4OSA4OSAwIDAwMjQgNCA0NSA0NSAwIDAwNiAwbDMtMSAxMy0xYTE1OCAxNTggMCAwMDU1LTE3IDYzIDYzIDAgMDAzNS01MiAzNCAzNCAwIDAwLTEtNWMtMy0xOC05LTMzLTE5LTQ3LTEyLTE3LTI0LTI4LTM4LTM3QTg1IDg1IDAgMDA2MiA3em0zMCA4YzIwIDQgMzggMTQgNTMgMzEgMTcgMTggMjYgMzcgMjkgNTh2MTJjLTMgMTctMTMgMzAtMjggMzhhMTU1IDE1NSAwIDAxLTUzIDE2bC0xMyAyaC0xYTUxIDUxIDAgMDEtMTItMWwtMTctMmMtMTMtNC0yMy0xMi0yOS0yNy01LTEyLTgtMjQtOC0zOWExMzMgMTMzIDAgMDE4LTUwYzUtMTMgMTEtMjYgMjYtMzMgMTQtNyAyOS05IDQ1LTV6TTQwIDQ1YTk0IDk0IDAgMDAtMTcgNTQgNzUgNzUgMCAwMDYgMzJjOCAxOSAyMiAzMSA0MiAzMiAyMSAyIDQxLTIgNjAtMTRhNjAgNjAgMCAwMDIxLTE5IDUzIDUzIDAgMDA5LTI5YzAtMTYtOC0zMy0yMy01MWE0NyA0NyAwIDAwLTUtNWMtMjMtMjAtNDUtMjYtNjctMTgtMTIgNC0yMCA5LTI2IDE4em0xMDggNzZhNTAgNTAgMCAwMS0yMSAyMmMtMTcgOS0zMiAxMy00OCAxMy0xMSAwLTIxLTMtMzAtOS01LTMtOS05LTEzLTE2YTgxIDgxIDAgMDEtNi0zMiA5NCA5NCAwIDAxOC0zNSA5MCA5MCAwIDAxNi0xMmwxLTJjNS05IDEzLTEzIDIzLTE2IDE2LTUgMzItMyA1MCA5IDEzIDggMjMgMjAgMzAgMzYgNyAxNSA3IDI5IDAgNDJ6bS00My03M2MtMTctOC0zMy02LTQ2IDUtMTAgOC0xNiAyMC0xOSAzN2E1NCA1NCAwIDAwNSAzNGM3IDE1IDIwIDIzIDM3IDIyIDIyLTEgMzgtOSA0OC0yNGE0MSA0MSAwIDAwOC0yNCA0MyA0MyAwIDAwLTEtMTJjLTYtMTgtMTYtMzEtMzItMzh6bS0yMyA5MWgtMWMtNyAwLTE0LTItMjEtN2EyNyAyNyAwIDAxLTEwLTEzIDU3IDU3IDAgMDEtNC0yMCA2MyA2MyAwIDAxNi0yNWM1LTEyIDEyLTE5IDI0LTIxIDktMyAxOC0yIDI3IDIgMTQgNiAyMyAxOCAyNyAzM3MtMiAzMS0xNiA0MGMtMTEgOC0yMSAxMS0zMiAxMXptMS0zNHYxNGgtOFY2OGg4djI4bDEwLTEwaDExbC0xNCAxNSAxNyAxOEg5NnoiLz48L3N2Zz4K
89+
[license-link]: ./LICENSE
90+
[license-shield]: https://img.shields.io/github/license/pdsinterop/solid-nextcloud.svg
91+
[maintained-shield]: https://img.shields.io/maintenance/yes/2023.svg
92+
[pdsinterop-shield]: https://img.shields.io/badge/-PDS%20Interop-7C4DFF.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9Ii01IC01IDExMCAxMTAiIGZpbGw9IiNGRkYiIHN0cm9rZS13aWR0aD0iMCI+CiAgICA8cGF0aCBkPSJNLTEgNTJoMTdhMzcuNSAzNC41IDAgMDAyNS41IDMxLjE1di0xMy43NWEyMC43NSAyMSAwIDAxOC41LTQwLjI1IDIwLjc1IDIxIDAgMDE4LjUgNDAuMjV2MTMuNzVhMzcgMzQuNSAwIDAwMjUuNS0zMS4xNWgxN2EyMiAyMS4xNSAwIDAxLTEwMiAweiIvPgogICAgPHBhdGggZD0iTSAxMDEgNDhhMi43NyAyLjY3IDAgMDAtMTAyIDBoIDE3YTIuOTcgMi44IDAgMDE2OCAweiIvPgo8L3N2Zz4K
93+
[pdsinterop-site]: https://pdsinterop.org/
94+
[project-stage-badge: Production Ready]: https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg
95+
[project-stage-page]: https://blog.pother.ca/project-stages/
96+
[standard-readme-link]: https://github.com/RichardLitt/standard-readme
97+
[standard-readme-shield]: https://img.shields.io/badge/-Standard%20Readme-brightgreen.svg
98+
[version-link]: https://packagist.org/packages/pdsinterop/solid-nextcloud
99+
[version-shield]: https://img.shields.io/github/v/release/pdsinterop/solid-nextcloud.svg?sort=semver

0 commit comments

Comments
 (0)