Skip to content

Commit

Permalink
Merge pull request #66 from sdtrdev/dev
Browse files Browse the repository at this point in the history
docs: add README.md and Code Owners
  • Loading branch information
damla authored Feb 23, 2021
2 parents 53440ca + f3b086b commit 9cd828a
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 10 deletions.
3 changes: 2 additions & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ CODE_OF_CONDUCT.md @damla @TheYkk
# `docs/getting-started.md` but not further nested files like
docs/* @damla @omerayyildiz

# docs/azure.md @username
docs/c.md @liveans
docs/cplusplus.md @liveans
47 changes: 40 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,47 @@
# Source Pocket

Source pocket for passionate developers!
## Table of contents

`Stil in progress, save your PRs!`
* [What is Source Pocket?](#What-is-Source-Pocket?)
* [Technologies](#technologies)
* [Setup](#setup)

---

## What is Source Pocket?

Source Pocket has been created to help developer community to easily find most useful resources according to their level. Everyone is free to share their favorite resources, simply by adding their links according to our [Contribution Guide](https://sourcepocket.netlify.app/docs/ "Contribution Guide").

## Technologies

Project is created with:

* [Docusaurus](https://v2.docusaurus.io "Docusaurus"): 2.0.0-alpha.69
* [ReactJS](https://reactjs.org "ReactJS"): 16.8.4
* [MDX](https://mdxjs.com "MDX"): 1.6.21
* [clsx](https://www.npmjs.com/package/clsx "clsx"): 1.1.1
* Passion of [software developers](https://discord.gg/J3PTmeFj6s "SDTRDEV") with some coffee and black tea 👩🏼‍💻☕️👨🏼‍💻☕️

## Setup

To run this project, install it locally using yarn:

```bash
$ yarn
$ yarn start
```

[Semantic Commits](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716) are important for everyone 🖊

Code Owners
------------
## Code Owners

* [@damla](https://github.com/damla "Damla KÖKSAL")
* [@omerayyildiz](https://github.com/omerayyildiz "Ömer AYYILDIZ")
* [@TheYkk](https://github.com/TheYkk "Kaan KARAKAYA")
* [@liveans](https://github.com/liveans "Ahmet İbrahim AKSOY")

---

## License

- [@damla](https://github.com/damla)
- [@omerayyildiz](https://github.com/omerayyildiz)
- [@TheYkk](https://github.com/TheYkk)
[MIT](https://choosealicense.com/licenses/mit/)
4 changes: 2 additions & 2 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ const features = [
{
title: "Easy to Reach",
imageUrl: "img/undraw_docusaurus_mountain.svg",
description: <>Useful sources from everwhere!</>,
description: <>Useful sources for every language!</>,
},
{
title: "Focus on What Matters",
imageUrl: "img/undraw_docusaurus_tree.svg",
description: <>Find what is important for you in our source pocket.</>,
description: <>Find crucial sources in our Source Pocket.</>,
},
];

Expand Down

0 comments on commit 9cd828a

Please sign in to comment.