Skip to content

Commit f48b9ae

Browse files
author
Convilyn Release
committed
chore(mirror): refresh community README + banner from monorepo
Projected from the monorepo SSOT after CoreNovus/convilyn#2273. README now matches sdk/*-python/README.md; adds docs/assets/corenovus-community-banner.png. Upstreamed in CoreNovus/convilyn#2273. Signed-off-by: Convilyn Release <releases@corenovus.com>
1 parent fea1a3a commit f48b9ae

2 files changed

Lines changed: 82 additions & 35 deletions

File tree

README.md

Lines changed: 82 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,82 @@
1-
# convilyn
2-
3-
[![CI](https://github.com/CoreNovus/convilyn-python/actions/workflows/ci.yml/badge.svg)](https://github.com/CoreNovus/convilyn-python/actions/workflows/ci.yml)
4-
5-
Official Convilyn client SDK — file conversion, agentic workflows, community library.
6-
7-
> **Public mirror** of Convilyn's monorepo (the source of truth). Contributions are
8-
> welcome and land in the shipped package — see
9-
> **[CONTRIBUTING.md](CONTRIBUTING.md)** (fork → PR → upstreamed, authorship preserved).
10-
11-
## Install
12-
13-
```bash
14-
pip install convilyn
15-
```
16-
17-
## Quickstart
18-
19-
See **[docs/QUICKSTART.md](docs/QUICKSTART.md)** and the full docs at
20-
<https://docs.convilyn.corenovus.com>.
21-
22-
23-
## Contributing
24-
25-
We use the **DCO** (`git commit -s`) — no CLA. Start with
26-
[CONTRIBUTING.md](CONTRIBUTING.md), the [Code of Conduct](CODE_OF_CONDUCT.md), and
27-
[good first issues](https://github.com/CoreNovus/convilyn-python/labels/good%20first%20issue).
28-
29-
## Security
30-
31-
Please report vulnerabilities privately — see [SECURITY.md](SECURITY.md).
32-
33-
## License
34-
35-
[Apache-2.0](LICENSE).
1+
<p align="center">
2+
<img src="docs/assets/corenovus-community-banner.png" alt="CoreNovus Community — Connected AI Workflows" />
3+
</p>
4+
5+
# convilyn
6+
7+
[![CI](https://github.com/CoreNovus/convilyn-python/actions/workflows/ci.yml/badge.svg)](https://github.com/CoreNovus/convilyn-python/actions/workflows/ci.yml)
8+
9+
Official Convilyn client SDK — file conversion, agentic workflows, and a community library for reusable AI workflows.
10+
11+
Convilyn helps people turn repeated AI-assisted work into workflows that can be run again, shared, and improved. It is part of the CoreNovus vision for practical AI workflows across cloud services, local machines, AI PCs, edge devices, and future IoT environments.
12+
13+
> **Public mirror** of Convilyn's monorepo (the source of truth). Contributions are
14+
> welcome and land in the shipped package — see
15+
> **[CONTRIBUTING.md](CONTRIBUTING.md)** (fork → PR → upstreamed, authorship preserved).
16+
17+
## What is Convilyn?
18+
19+
Convilyn is an open source Python SDK for building with free file conversion tools and basic AI workflow capabilities.
20+
21+
Its main value is helping people use the computing resources they already have — such as local machines, AI PCs, and edge devices — to run practical AI workflows without depending entirely on paid cloud services.
22+
23+
## Who is this for?
24+
25+
Convilyn is for:
26+
27+
- Developers building reusable AI workflow components
28+
- People working with file conversion and automation
29+
- Builders experimenting with local-first AI workflows
30+
- Communities that want open, practical AI tooling
31+
- Contributors who want to help make AI workflows easier to use and share
32+
33+
## Install
34+
35+
```bash
36+
pip install convilyn
37+
```
38+
39+
## Quickstart
40+
41+
See **[docs/QUICKSTART.md](docs/QUICKSTART.md)** and the full docs at:
42+
43+
[https://docs.convilyn.corenovus.com](https://docs.convilyn.corenovus.com)
44+
45+
## Community
46+
47+
Convilyn is maintained by CoreNovus, an independent developer team building open source tools for reusable AI workflows.
48+
49+
We welcome contributions from people who want to help improve documentation, examples, tests, file conversion workflows, local-first AI workflows, and developer experience.
50+
51+
A useful workflow should not disappear after one conversation. It should become something others can learn from, adapt, and run in their own context.
52+
53+
Start here:
54+
55+
* [Contributing Guide](CONTRIBUTING.md)
56+
* [Code of Conduct](CODE_OF_CONDUCT.md)
57+
* [Good first issues](https://github.com/CoreNovus/convilyn-python/labels/good%20first%20issue)
58+
* [CoreNovus on GitHub](https://github.com/CoreNovus)
59+
60+
## Project direction
61+
62+
CoreNovus is building toward a world where AI workflows can move beyond one-time chat sessions.
63+
64+
Convilyn focuses on the client SDK and community-facing workflow building blocks. The broader CoreNovus ecosystem aims to make workflows easier to create, save, reuse, share, and eventually run across cloud, local, and real-world environments.
65+
66+
## Contributing
67+
68+
We use the **DCO** (`git commit -s`) — no CLA.
69+
70+
Start with [CONTRIBUTING.md](CONTRIBUTING.md), the [Code of Conduct](CODE_OF_CONDUCT.md), and [good first issues](https://github.com/CoreNovus/convilyn-python/labels/good%20first%20issue).
71+
72+
Small documentation fixes, examples, tests, and issue reports are especially welcome.
73+
74+
## Security
75+
76+
Please report vulnerabilities privately — see [SECURITY.md](SECURITY.md).
77+
78+
Do not open a public GitHub issue for security vulnerabilities.
79+
80+
## License
81+
82+
[Apache-2.0](LICENSE).
829 KB
Loading

0 commit comments

Comments
 (0)