From 5e7798edbb86ba9e6047eaaab7269e9a6268c1b8 Mon Sep 17 00:00:00 2001
From: Kayhan Alizadeh <kehiiiiya@gmail.com>
Date: Wed, 15 Nov 2023 00:37:47 +0800
Subject: [PATCH] feat: initiating the repository  (#1)

Co-authored-by: Bruno Bernard <contact.brunobernard@gmail.com>
---
 .github/CODEOWNERS                |  1 +
 .github/workflows/check.yml       | 40 +++++++++++++++++++++++++++++++
 .github/workflows/semantic_pr.yml | 17 +++++++++++++
 IIPs/iip-0.md                     |  0
 README.md                         | 16 +++++++++++--
 iip-template.md                   |  0
 6 files changed, 72 insertions(+), 2 deletions(-)
 create mode 100644 .github/CODEOWNERS
 create mode 100644 .github/workflows/check.yml
 create mode 100644 .github/workflows/semantic_pr.yml
 create mode 100644 IIPs/iip-0.md
 create mode 100644 iip-template.md

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 0000000..ff696ec
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1 @@
+*/   @eznix86
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
new file mode 100644
index 0000000..e2aa778
--- /dev/null
+++ b/.github/workflows/check.yml
@@ -0,0 +1,40 @@
+name: Check
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  yaml:
+    name: Lining Yaml files
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v3
+
+      - name: Linting Yaml files
+        run: |
+          yarn run lint:yml:setup
+          yarn run lint:yml
+
+  markdown:
+    name: Lining Markdown files
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v3
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+
+      - name: Linting MD files
+        run: |
+          yarn run lint:md:setup
+          yarn run lint:md
diff --git a/.github/workflows/semantic_pr.yml b/.github/workflows/semantic_pr.yml
new file mode 100644
index 0000000..a68fe88
--- /dev/null
+++ b/.github/workflows/semantic_pr.yml
@@ -0,0 +1,17 @@
+name: Semantic PR
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/IIPs/iip-0.md b/IIPs/iip-0.md
new file mode 100644
index 0000000..e69de29
diff --git a/README.md b/README.md
index 8c61735..4ad8a59 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
-# IPNN
-IPNN specs
+# InterPlanetary Nostr Network Specification (IPNN) and Documentation
+
+IPNN is a protocol base on the [nostr](https://nostr.com).
+In IPNN each node is a nostr relay which is interconnected with p2p service model.
+
+This repository define how nodes should work and act in IPNN network. IIPs (IPNN improvement proposals) define the IPNN rules and improvements. the first IIP (IIP-0) define the basic IPNN protocol.
+
+# Contributing
+
+Contributions are welcomed. read the contribution docs before opening a PR.
+
+# License
+
+IPNN is under the [MIT](./LICENSE) License
\ No newline at end of file
diff --git a/iip-template.md b/iip-template.md
new file mode 100644
index 0000000..e69de29