Skip to content

Commit

Permalink
chore: Minor README improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
wottpal committed Oct 15, 2023
1 parent a6f89e1 commit ee45995
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributor Guidelines
# Contributing Guidelines

[Scio Labs](https://scio.xyz) actively welcomes contributions from anyone to make this a community-driven effort. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code.

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# ink!athon Boilerplate

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge.svg)](https://github.com/paritytech/ink)
[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge.svg)](https://use.ink)
![Rust](https://img.shields.io/badge/Rust-000000?logo=rust&logoColor=white)
![TypeScript](https://img.shields.io/badge/TypeScript-000000?logo=typescript&logoColor=white)
![Next.js](https://img.shields.io/badge/Next.js-000000?logo=next.js&logoColor=white)
Expand Down Expand Up @@ -115,9 +115,9 @@ There are multiple places where you need to insert your project's name and ident

Additionally, there are the following un-highlighted occurrences:

- The name of the `inkathon.code-workspace` file
- The package names within `package.json`, `frontend/package.json`, and `contracts/package.json`
- The workspace dependency defined in `frontend/package.json` and `frontend/src/deployments/deployments.ts`
- the name of the `inkathon.code-workspace` file
- the `package.json`'s name & metadata in the root directory as well as in the `contracts/` and `frontend/` packages
- the workspace dependency (`@inkathon/contracts`) defined in `frontend/package.json` and imported in `frontend/src/deployments/deployments.ts`

### 2. Custom Contracts

Expand Down
5 changes: 1 addition & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
"name": "@inkathon/monorepo",
"description": "Full-Stack DApp Boilerplate for ink! Smart Contracts",
"homepage": "https://inkathon.xyz",
"author": "Scio Labs <[email protected]> (https://scio.xyz)",
"private": true,
"repository": {
"type": "git",
"url": "git+https://github.com/scio-labs/inkathon"
},
"workspaces": [
"frontend",
"contracts"
Expand Down

1 comment on commit ee45995

@vercel
Copy link

@vercel vercel bot commented on ee45995 Oct 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.