Skip to content

Commit 379029b

Browse files
authored
Merge pull request #7622 from LibreSign/backport/6988/stable33
[stable33] improve README structure and installation instructions
2 parents d106a5f + eff3593 commit 379029b

1 file changed

Lines changed: 47 additions & 17 deletions

File tree

README.md

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
- SPDX-FileCopyrightText: 2020-2024 LibreCode coop and contributors
2+
- SPDX-FileCopyrightText: 2020-2026 LibreCode coop and contributors
33
- SPDX-License-Identifier: AGPL-3.0-or-later
44
-->
55
![Test Status](https://github.com/LibreSign/libresign/actions/workflows/behat.yml/badge.svg?branch=main)
@@ -8,35 +8,65 @@
88
[![REUSE status](https://api.reuse.software/badge/github.com/LibreSign/libresign)](https://api.reuse.software/info/github.com/LibreSign/libresign)
99
[![Start contributing](https://img.shields.io/github/issues/LibreSign/libresign/good%20first%20issue?color=7057ff&label=Contribute)](https://github.com/LibreSign/libresign/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
1010

11-
Nextcloud app to sign PDF documents.
11+
# LibreSign
1212

13-
<img src="img/LibreSign.png" />
13+
Control how your documents get signed
1414

15-
[![Request a feature](https://img.shields.io/badge/Request%20a%20feature-7057ff?style=for-the-badge)](https://github.com/LibreSign/libresign/issues/new?template=feature_request.yml)
16-
[![Report a BUG](https://img.shields.io/badge/Report%20a%20bug-8e0000?style=for-the-badge)](https://github.com/LibreSign/libresign/issues/new?template=bug_report.yml)
15+
LibreSign helps you control how document signing works in your organization.
16+
Organizations use it with Nextcloud to run signing workflows that match internal rules, legal requirements, and daily processes.
17+
It gives teams clear visibility into who signed, when they signed, and how each request moved through the process.
1718

18-
## Star History
19+
## Key features
1920

20-
[![Star History Chart](https://api.star-history.com/svg?repos=libresign/libresign&type=Date)](https://www.star-history.com/#libresign/libresign&Date)
21+
- Define signing order, roles, and rules per document flow
22+
- Include internal and external signers in the same request
23+
- Keep a traceable record of requests, actions, and validations
24+
- Work directly with Nextcloud files, users, and sharing context
25+
- Configure certificates and identity options for your signing process
26+
- Integrate signing with other systems through APIs
2127

22-
## Contributing
28+
## Why LibreSign
2329

24-
There are many ways to contribute, including writing code, filing issues on GitHub, helping people Overflow, helping to triage, reproduce, or fix bugs that people have filed, adding to our documentation.
25-
To get more details go to our [contributing guide](CONTRIBUTING.md).
30+
LibreSign is for teams where signing is part of a controlled business process.
2631

27-
## Integrations
32+
- Define clear signing rules by role, stage, or document type
33+
- Keep traceability for audits, legal checks, and internal reviews
34+
- Align signing with existing approval and governance processes
35+
- Adapt workflows to how your organization works instead of following fixed external models
2836

29-
* [GLPI](https://github.com/LibreSign/libresign-glpi): Plugin to sign GLPI tickets
30-
* [Approval](https://github.com/nextcloud/approval): Approve/reject files based on workflows defined by admins
37+
## Contributing
3138

32-
## API Documentation
39+
Contributions are welcome from developers, implementers, and teams that use LibreSign in production.
3340

34-
[API Documentation](https://libresign.github.io/)
41+
- Report bugs and suggest improvements: https://github.com/LibreSign/libresign/issues
42+
- Start with good first issues: https://github.com/LibreSign/libresign/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
43+
- Read contribution guidelines: CONTRIBUTING.md
44+
- Help with translations: https://app.transifex.com/nextcloud/nextcloud/libresign
3545

36-
## Contributors
46+
## Contributors
3747

38-
Thanks go to these wonderful people:
48+
Thanks to all the people who contribute to LibreSign:
3949

4050
<a href="https://github.com/LibreSign/libresign/graphs/contributors">
4151
<img src="https://contrib.rocks/image?repo=LibreSign/libresign" />
4252
</a>
53+
54+
## Screenshots
55+
56+
<p align="center">
57+
<img src="img/LibreSign.png" alt="LibreSign interface screenshot" width="900"/>
58+
</p>
59+
60+
## Documentation
61+
62+
- Official documentation: https://docs.libresign.coop/
63+
- Developer manual: https://docs.libresign.coop/developer_manual/
64+
- Documentation repository: https://github.com/LibreSign/documentation
65+
66+
## Sponsors
67+
68+
If your organization depends on LibreSign, please sponsor the project.
69+
70+
Sponsorship directly supports ongoing maintenance, reliable releases, better documentation, and long-term continuity for teams that rely on LibreSign in real workflows.
71+
72+
Support LibreSign: https://github.com/sponsors/LibreSign

0 commit comments

Comments
 (0)