cleaning up documentation

enochval · Jun 14, 2024 · 455fbc2 · 455fbc2
1 parent b89ddbd
commit 455fbc2
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 31 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,6 +1,3 @@
-
-#### CODE_OF_CONDUCT.md
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,4 @@
-
-#### CONTRIBUTING.md
-
-
-# Contributing to JSON Placeholder GraphQL API
+# Contributing to GraphQL Placeholder
 
 Thank you for considering contributing to our project! We appreciate your time and effort.
 
@@ -11,7 +7,7 @@ Thank you for considering contributing to our project! We appreciate your time a
 1. **Fork the repository** on GitHub.
 2. **Clone your fork** locally:
  ```bash
- git clone https://github.com/yourusername/json-placeholder-graphql.git
+ git clone https://github.com/yourusername/graphql-placeholder.git
  ```
 3. **Create a branch** for your contribution:
  ```bash
@@ -45,11 +41,11 @@ Please follow the coding style used throughout the project. Write clear, concise
 1. Clone the repository:
 
 ```bash
-git clone https://github.com/yourusername/json-placeholder-graphql.git
+git clone https://github.com/yourusername/graphql-placeholder.git
 ```
 
 ```bash
-cd json-placeholder-graphql
+cd graphql-placeholder
 ```
 
 2. Install dependencies:

diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 <p align="center">
- <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="100" alt="Nest Logo" /></a>
- <a href="http://nestjs.com/" target="blank"><img src="https://www.vectorlogo.zone/logos/graphql/graphql-icon.svg" width="100" alt="GraphQL Logo" /></a>
+ <a href="https://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="100" alt="Nest Logo" /></a>
+ <a href="https://graphql.org/" target="blank"><img src="https://www.vectorlogo.zone/logos/graphql/graphql-icon.svg" width="100" alt="GraphQL Logo" /></a>
 </p>
 
-# JSON Placeholder GraphQL API
+# GraphQL Placeholder
 
-<p align="center">Welcome to the <a href="https://graphqljsonplaceholder.vercel.app" target="blank">JSON Placeholder GraphQL API</a>!</p>
+<p align="center">Welcome to the <a href="https://graphqlplaceholder.vercel.app" target="blank">GraphQL Placeholder</a>!</p>
  <p align="center">
 <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
 <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
@@ -22,7 +22,7 @@
 
 ## Description
 
-This project is a NestJS GraphQL implementation of the popular [JSON Placeholder](https://jsonplaceholder.typicode.com) API, providing developers with a GraphQL playground for testing and experimentation.
+[GraphQL Placeholder](https://graphqlplaceholder.vercel.app) is a [NestJS](https://nestjs.com) GraphQL implementation of the popular [JSON Placeholder](https://jsonplaceholder.typicode.com) API, providing developers with a [GraphQL playground](https://graphqlplaceholder.vercel.app/graphql) for testing and experimentation.
 
 ## Features
 
@@ -35,26 +35,26 @@ This project is a NestJS GraphQL implementation of the popular [JSON Placeholder
 - Supports QUERY, MUTATION
 - HTTP or HTTPS
 - Compatible with React, Angular, Vue, Ember, ...
-- **GraphQL Playground**: An interactive playground for testing GraphQL queries and mutations.
-- **NestJS Framework**: Built with NestJS for high performance and maintainability.
-- **JSON Placeholder Integration**: Seamless integration with JSON Placeholder API data including posts, comments, users, todos, albums and photos.
-- **Type-safe Queries**: Utilize TypeScript for a smooth and error-free development experience.
+- An interactive playground for testing GraphQL queries and mutations.
+- Built with NestJS for high performance and maintainability.
+- Seamless integration with JSON Placeholder API data including posts, comments, users, todos, albums and photos.
+- Utilize TypeScript for a smooth and error-free development experience.
 
 ## Usage
 
 - **Queries:** Fetch data such as posts, comments, users, etc., from the JSON Placeholder API using GraphQL queries.
 - **Mutations:** Test data manipulation operations like creating, updating, and deleting resources.
 
 ## Guide
-For examples and more, you can visit https://graphqljsonplaceholder.vercel.app/graphql
+For examples and more, you can visit https://graphqlplaceholder.vercel.app/graphql
 
 ## Contributing
 
-We welcome contributions from the community! Please read our CONTRIBUTING.md to get started.
+We welcome contributions from the community! Please read our [CONTRIBUTING.md](./CONTRIBUTING.md) to get started.
 
 ## License
 
-This project is licensed under the MIT License - see the LICENSE file for details.
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
 
 ## Stay in touch
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -5,12 +5,6 @@
 Use this section to tell people about which versions of your project are
 currently being supported with security updates.
 
-| Version | Supported |
-| ------- | ------------------ |
-| 5.1.x | :white_check_mark: |
-| 5.0.x | :x: |
-| 4.0.x | :white_check_mark: |
-| < 4.0 | :x: |
 
 ## Reporting a Vulnerability
 

diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
- "name": "json-placeholder-api-nestjs-graphqlhub",
+ "name": "graphql-placeholder",
  "version": "0.0.1",
  "description": "",
- "author": "",
+ "author": "osarenrenenoch@gmail.com",
  "private": true,
  "license": "UNLICENSED",
  "scripts": {