Skip to content

Commit 9f7c421

Browse files
sanityclaude
andauthored
docs: add minimal READMEs for freenet and fdev crates (#1964)
Co-authored-by: Claude <noreply@anthropic.com>
1 parent 5937f2a commit 9f7c421

File tree

5 files changed

+795
-730
lines changed

5 files changed

+795
-730
lines changed

crates/core/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ publish = true
77
description = "Freenet core software"
88
license-file = "LICENSE.md"
99
repository = "https://github.com/freenet/freenet-core"
10+
readme = "README.md"
1011

1112
[[bin]]
1213
name = "freenet"

crates/core/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Freenet
2+
3+
Freenet is a decentralized, peer-to-peer platform that transforms users' computers into a resilient, distributed platform on which anyone can build decentralized services.
4+
5+
This is the core Freenet software that powers the network.
6+
7+
## Resources
8+
9+
- **Website**: [freenet.org](https://freenet.org/)
10+
- **GitHub**: [github.com/freenet/freenet-core](https://github.com/freenet/freenet-core)
11+
- **Documentation**: [GitHub README](https://github.com/freenet/freenet-core#readme)
12+
- **API Docs**: [docs.rs/freenet](https://docs.rs/freenet)
13+
- **Community**: [Matrix chat](https://matrix.to/#/#freenet:matrix.org)
14+
15+
## Installation
16+
17+
```bash
18+
cargo install freenet
19+
```
20+
21+
For detailed build instructions and development setup, see the [GitHub repository](https://github.com/freenet/freenet-core).
22+
23+
## License
24+
25+
Licensed under either:
26+
- Apache License, Version 2.0
27+
- MIT License
28+
29+
at your option.

crates/fdev/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ rust-version = "1.80"
66
publish = true
77
description = "Freenet development tool"
88
license-file = "LICENSE.md"
9-
repository = "https://github.com/freenet/freenet"
9+
repository = "https://github.com/freenet/freenet-core"
10+
readme = "README.md"
1011

1112
[dependencies]
1213
bytesize = "2.0"

0 commit comments

Comments
 (0)