react 공식 readme 작성 참고하기

joyoung·2024년 8월 14일
0

react 공식 readme 를 참고하여 redeme.md 작성하기

기여 등 핵심 내용을 정리해본 결과 하기와 같다

  1. 프로젝트 요약 및 소개 ( 의존성 및 버전 )
  2. 설치 방법
  3. 예시 코드
  4. 라이센스

1. 프로젝트 소개

1-1 타이틀 및 뱃지

# [React](https://react.dev/) · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)]
(https://github.com/facebook/react/blob/main/LICENSE) [![npm version]
(https://img.shields.io/npm/v/react.svg?style=flat)](https://www.npmjs.com/package/react) 
[![(Runtime) Build and Test]
(https://github.com/facebook/react/actions/workflows/runtime_build_and_test.yml/badge.svg
)](https://github.com/facebook/react/actions/workflows/runtime_build_and_test.yml) [!
[(Compiler) TypeScript]
(https://github.com/facebook/react/actions/workflows/compiler_typescript.yml/badge.svg?branch=main)]
(https://github.com/facebook/react/actions/workflows/compiler_typescript.yml) [![PRs Welcome]
(https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://legacy.reactjs.org/docs/how-to-contribute.html#your-first-pull-request)

리액트의 의존성을 로고로 깔끔 하게 표시하였다 .

1-2 프로젝트 요약 및 소개

React의 주요 개념과 장점을 간단하고 명확하게 설명

React is a JavaScript library for building user interfaces.

* **Declarative:** React makes it painless to create interactive UIs. Design simple views for each state in your application, and React will efficiently update and render just the
right components when your data changes. Declarative views make your code more 
predictable, simpler to understand, and easier to debug.
* **Component-Based:** Build encapsulated components that manage their own state, then 
compose them to make complex UIs. Since component logic is written in JavaScript instead 
of templates, you can easily pass rich data through your app and keep the state out of
the DOM.
* **Learn Once, Write Anywhere:** We don't make assumptions about the rest of your 
technology stack, so you can develop new features in React without rewriting existing 
code. React can also render on the server using [Node](https://nodejs.org/en) and power 
mobile apps using [React Native](https://reactnative.dev/).

[Learn how to use React in your project](https://react.dev/learn).

2. 설치 방법

프로젝트를 설치하는 방법 작성

## Installation

React has been designed for gradual adoption from the start, and **you can use as little or as much React as you need**:

npx create-next-app@latest

3. 예시 코드

기능 사용법을 예시코드로 작성

## Examples

We have several examples [on the website](https://react.dev/). Here is the first one to get you started:


import { createRoot } from 'react-dom/client';

function HelloMessage({ name }) {
  return <div>Hello {name}</div>;
}

const root = createRoot(document.getElementById('container'));
root.render(<HelloMessage name="Taylor" />);


This example will render "Hello Taylor" into a container on the page.

You'll notice that we used an HTML-like syntax; [we call it JSX](https://react.dev/learn#writing-markup-with-jsx). JSX is not required to use React, but it makes code more readable, and writing it feels like writing HTML.

4. 라이센스

저작권을 명시해줌으로서 상업적 사용가능 범위 명시

### License

React is [MIT licensed](./LICENSE).
profile
꾸준히

0개의 댓글