nimbus-eth1/fluffy/README.md

# Fluffy: The Nimbus Portal Network Client

[![Fluffy CI](https://github.com/status-im/nimbus-eth1/actions/workflows/fluffy.yml/badge.svg)](https://github.com/status-im/nimbus-eth1/actions/workflows/fluffy.yml)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
[![License: Apache](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![Discord: Nimbus](https://img.shields.io/badge/Discord-Nimbus-blue.svg)](https://discord.gg/XRxWahP)
[![Status: #nimbus-general](https://img.shields.io/badge/Status-nimbus--general-blue.svg)](https://join.status.im/nimbus-general)

## Introduction

Fluffy is the Nimbus client implementation of the
[Portal network specifications](https://github.com/ethereum/portal-network-specs).

You can find all the information you need to run a Fluffy node in
[The Fluffy Book](https://status-im.github.io/nimbus-eth1).

The [quickstart page](https://status-im.github.io/nimbus-eth1/quick-start.html)
in particular will help you to get quickly connected to the Portal network.

## Development Updates

Monthly development updates are shared
[here](https://hackmd.io/jRpxY4WBQJ-hnsKaPDYqTw).

To keep up to date with changes and development progress, follow the
[Nimbus blog](https://our.status.im/tag/nimbus/).

## License

Licensed and distributed under either of

* MIT license: [LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT

or

* Apache License, Version 2.0, ([LICENSE-APACHEv2](../LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)

at your option. These files may not be copied, modified, or distributed except according to those terms.
Add monthly development updates link (#776) * Update readme with adjusted intro and dev updates link * Remove pcre from prerequisites as it no longer is * Change to hackmd doc as status notes seem not accessible 2021-08-09 14:10:58 +00:00			`# Fluffy: The Nimbus Portal Network Client`
Add nlpn readme (#718) * Do not run nlpn CI on md files in nlpn folder * Add nlpn README.md 2021-06-17 15:05:00 +00:00
Clarify Fluffy's docs and config (#1402) 2023-01-02 15:37:22 +00:00			`[![Fluffy CI](https://github.com/status-im/nimbus-eth1/actions/workflows/fluffy.yml/badge.svg)](https://github.com/status-im/nimbus-eth1/actions/workflows/fluffy.yml)`
Add nlpn readme (#718) * Do not run nlpn CI on md files in nlpn folder * Add nlpn README.md 2021-06-17 15:05:00 +00:00			`![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)`
			`[![License: Apache](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)`
			`[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)`

			`[![Discord: Nimbus](https://img.shields.io/badge/Discord-Nimbus-blue.svg)](https://discord.gg/XRxWahP)`
			`[![Status: #nimbus-general](https://img.shields.io/badge/Status-nimbus--general-blue.svg)](https://join.status.im/nimbus-general)`

			`## Introduction`

Add more documentation to the fluffy book and reorganize it (#1856) Moved pretty much everything from the readme.md file now to the book and structured it better to be more accessible. 2023-10-24 16:18:30 +00:00			`Fluffy is the Nimbus client implementation of the`
Dead link fixes and other small improvements to the fluffy book (#1859) 2023-10-25 11:23:17 +00:00			`[Portal network specifications](https://github.com/ethereum/portal-network-specs).`
Add nlpn readme (#718) * Do not run nlpn CI on md files in nlpn folder * Add nlpn README.md 2021-06-17 15:05:00 +00:00
Add more documentation to the fluffy book and reorganize it (#1856) Moved pretty much everything from the readme.md file now to the book and structured it better to be more accessible. 2023-10-24 16:18:30 +00:00			`You can find all the information you need to run a Fluffy node in`
			`[The Fluffy Book](https://status-im.github.io/nimbus-eth1).`

			`The [quickstart page](https://status-im.github.io/nimbus-eth1/quick-start.html)`
			`in particular will help you to get quickly connected to the Portal network.`
Add nlpn readme (#718) * Do not run nlpn CI on md files in nlpn folder * Add nlpn README.md 2021-06-17 15:05:00 +00:00
			`## Development Updates`

Add Portal protocol testing docs and more (#912) - Add portal network ping and findNodes JSON-RPC endpoints - clean-up of some cli arguments - Add protocol_interop.md document and adjust/fix other documentation 2021-12-13 13:12:51 +00:00			`Monthly development updates are shared`
			`[here](https://hackmd.io/jRpxY4WBQJ-hnsKaPDYqTw).`

Update Fluffy docs on how to seed data (#1408) 2023-01-09 16:57:55 +00:00			`To keep up to date with changes and development progress, follow the`
			`[Nimbus blog](https://our.status.im/tag/nimbus/).`

Add nlpn readme (#718) * Do not run nlpn CI on md files in nlpn folder * Add nlpn README.md 2021-06-17 15:05:00 +00:00			`## License`

			`Licensed and distributed under either of`

Change name from nlpn to fluffy (#734) 2021-06-28 15:53:13 +00:00			`* MIT license: [LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT`
Add nlpn readme (#718) * Do not run nlpn CI on md files in nlpn folder * Add nlpn README.md 2021-06-17 15:05:00 +00:00
			`or`

Change name from nlpn to fluffy (#734) 2021-06-28 15:53:13 +00:00			`* Apache License, Version 2.0, ([LICENSE-APACHEv2](../LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)`
Add nlpn readme (#718) * Do not run nlpn CI on md files in nlpn folder * Add nlpn README.md 2021-06-17 15:05:00 +00:00
			`at your option. These files may not be copied, modified, or distributed except according to those terms.`