Skip to content

Commit

Permalink
Merge pull request #116 from atsign-foundation/cpswan-fix-readme
Browse files Browse the repository at this point in the history
docs: Lint README and remove spurious line
  • Loading branch information
XavierChanth authored Dec 12, 2023
2 parents 84782c2 + 7dc6da1 commit 0b87c81
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,39 @@
<a href="https://atsign.com#gh-light-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2022/05/atsign-logo-horizontal-color2022.svg#gh-light-mode-only" alt="The Atsign Foundation"></a><a href="https://atsign.com#gh-dark-mode-only"><img width=250px src="https://atsign.com/wp-content/uploads/2023/08/atsign-logo-horizontal-reverse2022-Color.svg#gh-dark-mode-only" alt="The Atsign Foundation"></a>
<h1><a href="https://atsign.com#gh-light-mode-only">
<img width=250px src="https://atsign.com/wp-content/uploads/2022/05/atsign-logo-horizontal-color2022.svg#gh-light-mode-only"
alt="The Atsign Foundation"></a><a href="https://atsign.com#gh-dark-mode-only">
<img width=250px src="https://atsign.com/wp-content/uploads/2023/08/atsign-logo-horizontal-reverse2022-Color.svg#gh-dark-mode-only"
alt="The Atsign Foundation"></a></h1>

[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://github.com/atsign-foundation/at_protocol/blob/trunk/LICENSE)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/at_protocol/badge)](https://api.securityscorecards.dev/projects/github.com/atsign-foundation/at_protocol)
NA - Documentation repo, though implementations such as at_client_sdk do have tests

# The atProtocol Specification

This repository is home to the [open source specification for The atProtocol](specification/at_protocol_specification.md) as well as supporting documentation.
This repository is home to the
[open source specification for The atProtocol](specification/at_protocol_specification.md)
as well as supporting documentation.

## This repo is for anyone interested in:
## This repo is for anyone interested in

1. Understanding what The atProtocol is and how it works.
2. Contributing to the specification with suggestions, edits or proposed changes.
3. Implementing another reference implementation that us interoperatable with others.
2. Contributing to the specification with suggestions, edits or proposed
changes.
3. Implementing another reference implementation that us interoperatable with
others.

The intent of the specifation is to define the actors, roles, responsibilities required to implement a working system that is atProtocol compliant.
The intent of the specifation is to define the actors, roles, responsibilities
required to implement a working system that is atProtocol compliant.

The specification itself is a simple markdown document that is easiy to view and edit.
The specification itself is a simple markdown document that is easiy to view
and edit.

### Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidance on how to submit changes and make pull requests.
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidance on how to
submit changes and make pull requests.

## Maintainers

This document was created and is maintained by:
- [Colin Constable](https://github.com/cconstab)
- [Murali Dharan](https://github.com/murali-shris)
Expand Down

0 comments on commit 0b87c81

Please sign in to comment.